GW2FileErrorMsg

Fungsi GW2FileErrorMsg mengambil pesan kesalahan yang dilaporkan oleh Glasswall untuk session ID tertentu. Pesan kesalahan ditempatkan dalam buffer output.

Jika ada lebih dari satu alasan untuk kesalahan tersebut, hanya satu yang akan dilaporkan oleh pemanggilan fungsi ini. Jika detail diperlukan untuk kegagalan tersebut, detail itu akan ada dalam laporan analisis yang dihasilkan jika salah satu fungsi GW2RegisterAnalysisFile atau GW2AnalysisRegisterMemory dipanggil pada sesi tersebut. Jika tidak, dokumen dapat diproses oleh Glasswall menggunakan salah satu fungsi tersebut dalam sesi lain untuk menghasilkan laporan analisis yang terperinci.

C++
C#
Java
Python
JavaScript

Sinopsis

#include "glasswall.core2.api.h"


// The **GW2FileErrorMsg** function retrieves the error message reported by Glasswall.
// A pointer to the error message is placed in the object pointed to by **errorMsgBuffer**
// and the size, in bytes, of the error message is placed in the **size_t** object
// pointed to by **errorMsgBufferLength**.

int GW2FileErrorMsg(
    Session session,
    char **errorMsgBuffer,
    size_t *errorMsgBufferLength);

Hasil pengembalian

Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.

Sinopsis

/// <summary>
///
/// </summary>
/// <param name="session">Session ID number</param>
/// <param name="outputBuffer">Location in memory where the error message will be placed</param>
/// <param name="bufferLength">Size of the output buffer</param>
public int FileErrorMsg(
    int session,
    out IntPtr outputBuffer,
    ref UIntPtr bufferLength)

Hasil pengembalian

Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.

Sinopsis

import com.glasswall.core2javabridge.*;

public String GW2FileErrorMsgString(int session) throws GlasswallException

Catatan

Parameter fungsi GW2FileErrorMsgString telah diperbarui untuk menggunakan String sebagai pengganti byte[], dan untuk menghilangkan kebutuhan memanggil GetErrorBuffer guna mengambil data. Fungsi aslinya telah ditandai usang.

Hasil pengembalian

GW2FileErrorMsgString mengembalikan String yang berisi pesan kesalahan sesi. String akan kosong jika tidak ada pesan kesalahan yang dapat diambil.

Pengecualian GlasswallException akan dilempar jika session tidak valid, atau jika pesan kesalahan tidak dapat diambil.

Sinopsis - Fungsi yang Tidak Digunakan Lagi

import com.glasswall.core2javabridge.*;

(Deprecated)
public int GW2FileErrorMsg(int session) throws GlasswallException
public byte[] GetErrorBuffer(int session) throws GlasswallException

Deskripsi

Fungsi GW2FileErrorMsg mengeluarkan pesan kesalahan file untuk sesi yang ditentukan oleh session ke buffer internal. Panggil GetErrorBuffer setelah memanggil GW2RunSession untuk mengambil data pesan kesalahan.

Lihat API Overview/Return types untuk enumerator yang valid bagi format.

Nilai yang Dikembalikan - Fungsi yang Tidak Digunakan Lagi

Fungsi GW2FileErrorMsg mengembalikan enumerasi GW2_RetStatus yang dikonversi menjadi int. Nilainya akan negatif jika terjadi kesalahan. 0 menunjukkan keberhasilan. Lihat API Overview/Return types untuk detailnya.

Fungsi GetErrorBuffer mengembalikan array byte yang berisi detail kesalahan. Nilainya akan null jika GW2FileErrorMsg belum dipanggil.

Pengecualian GlasswallException akan dilempar jika session tidak valid, atau jika pesan kesalahan tidak dapat diambil.

Sinopsis

Ambil pesan kesalahan Glasswall Session Process.

def file_error_message(self, session: int) -> str:
    """ Retrieve the Glasswall Session Process error message.

    Args:
        session (int): The session integer.

    Returns:
        error_message (str): The Glasswall Session Process error message.
    """

Hasil pengembalian

Pesan kesalahan sebagai string.

Sinopsis

/**
* This function retrieves the error message reported by Glasswall. If more than one error
* is reported, the last one will be returned.
*
*/
GW2FileErrorMsg(
    session,
    errorMsgBuffer,
    errorMsgBufferLength)

Hasil pengembalian

Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.

Contoh

function getFileErrorMsg(session_id, gw) {
    /*
        GW2FileErrorMsg API signature
        int GW2FileErrorMsg(
            Session session,
            char **errorMsgBuffer,
            size_t *errorMsgBufferLength
        );
    */

    // allocate pointer space to store the pointer to the message buffer
    let CString_ptr = ref.refType(ref.types.CString);
    let errorMsgBuffer = ref.alloc(CString_ptr);

    // allocate space to store the buffer length; use .deref() to extract it
    let errorMsgBufferLength = ref.alloc('size_t');

    let rv = gw.GW2FileErrorMsg(session_id, errorMsgBuffer, errorMsgBufferLength);

    buf_len = errorMsgBufferLength.deref();
    if (buf_len == 0)
        arr_buf = "";
    else
        arr_buf = buffer_to_array(errorMsgBuffer, errorMsgBufferLength);

    let message = `\n  GW2FileErrorMsg:return=${rv}`;
    message += "\n    errorMsgBuffer = \"" + arr_buf.toString() + '"';
    message += `\n    errorMsgBufferLength = ${buf_len}`;

    return message;
}