GW2RegisterAnalysisMemory

Sinopsis

Fungsi GW2RegisterAnalysisMemory menyimpan dalam objek yang ditunjuk oleh analysisFileBuffer sebuah pointer ke laporan analisis yang dihasilkan oleh eksekusi berhasil dari fungsi API runSession yang menggunakan sesi session. Ukuran laporan analisis, dalam byte, ditempatkan dalam objek yang ditunjuk oleh analysisLength. Format laporan analisis akan mengikuti format yang diminta oleh format. Menggunakan fungsi ini mengaktifkan Analysis Process Mode untuk sesi tersebut.

#include "glasswall.core2.api.h"

int GW2RegisterAnalysisMemory(Session session,
                              char **analysisFileBuffer,
                              size_t analysisLength,
                              Analysis_format format);

Hasil pengembalian

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

Contoh

#include "glasswall.core2.api.h"

Session_Handle session;
char *analysisReport = NULL;
size_t analysisReportSize = 0;

session = GW2OpenSession();

if (!session)
    /* deal with error */
else
{
    if (GW2RegisterAnalysisMemory(session, &analysisReport, &analysisReportSize, PF_XML) < 0)
        /* deal with error */
    else
        /* analysisReport points to the analysis report data */
}

/* later */
if (GW2CloseSession(session) < 0)
    /* error closing session */

Sinopsis

public int RegisterAnalysisMemory(
    int session,
    out IntPtr analysisBufferPtr,
    ref UIntPtr analysisBufferLengthPtr,
    int Format)

Hasil pengembalian

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

Sinopsis

import com.glasswall.core2javabridge.*;

public int GW2RegisterAnalysisMemory(int session, int format) throws GlasswallException

Deskripsi

Fungsi GW2RegisterAnalysisMemory mendaftarkan buffer memori sebagai output untuk laporan analisis, untuk sesi yang ditentukan oleh session. Panggil GetAnalysisBuffer atau GetAnalysisReport setelah memanggil GW2RunSession untuk mengambil laporan analisis.

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

Hasil pengembalian

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

Pengecualian GlasswallException akan dilempar jika session tidak valid.

Sinopsis - Ambil Data

import com.glasswall.core2javabridge.*;

public byte[] GetAnalysisBuffer(int session) throws GlasswallException
public String GetAnalysisReport(int session) throws GlasswallException

Deskripsi

Fungsi GetAnalysisBuffer mengambil isi buffer laporan analisis yang terkait dengan sesi yang ditentukan oleh session.

Hasil pengembalian

Fungsi GetAnalysisBuffer mengembalikan Byte[] yang berisi laporan analisis. Fungsi GetAnalysisReport mengembalikan String yang berisi laporan analisis. Nilainya akan null jika GW2RunSession dan GW2RegisterAnalysisMemory belum dipanggil.

Pengecualian GlasswallException akan dilempar jika session tidak valid.

Sinopsis

Mendaftarkan file analisis untuk session yang diberikan. File analisis akan dibuat selama pemanggilan run_session pada session tersebut.

def register_analysis(self, session: int, output_file: Optional[str] = None):
    """ Registers an analysis file for the given session. The analysis file will be created during the session's run_session call.

    Args:
        session (int): The session integer.
        output_file (Optional[str]): Default None. The file path where the analysis will be written. None returns the analysis as bytes.

    Returns:
        gw_return_object (glasswall.GwReturnObj): A GwReturnObj instance with the attributes 'status', 'session', 'analysis_format'. If output_file is None (memory mode), 'buffer', and 'buffer_length' are included containing the file content and file size. If output_file is not None (file mode) 'output_file' is included.
    """

Hasil pengembalian

gw_return_object (glasswall.GwReturnObj): Instance GwReturnObj dengan atribut 'status', 'session', 'analysis_format'. Jika output_file adalah None (mode memori), 'buffer' dan 'buffer_length' disertakan yang berisi konten file dan ukuran file. Jika output_file bukan None (mode file) 'output_file' disertakan.

Atribut status adalah nilai enum bilangan bulat GW2_RetStatus. Angka negatif menunjukkan kegagalan.

Sinopsis

Fungsi ini menyimpan pointer ke laporan analisis yang dihasilkan oleh eksekusi runSession yang berhasil.

/**
 *
 * @param {number} session The ID of the session.
 * @param {string} analysisFileBuffer The pointer to the location of the analysis report.
 * @param {number} analysisOutputLength The size of the analysis report.
 * @param {number} format The specified format.
 */

GW2RegisterAnalysisMemory(
    session,
    analysisFileBuffer,
    analysisOutputLength,
    format)

Hasil pengembalian

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