GW2RegisterAnalysisMemory

Sinopsis

Fungsi GW2RegisterAnalysisMemory menyimpan dalam objek yang ditunjukkan oleh analysisFileBuffer satu penuding kepada laporan analisis yang dihasilkan oleh pelaksanaan berjaya fungsi API runSession yang menggunakan sesi session. Saiz laporan analisis, dalam bait, diletakkan dalam objek yang ditunjukkan oleh analysisLength. Format laporan analisis akan mengikut format yang diminta oleh format. Penggunaan fungsi ini mengaktifkan Mod Proses Analisis untuk sesi tersebut.

#include "glasswall.core2.api.h"

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

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor 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)

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.

Sinopsis

import com.glasswall.core2javabridge.*;

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

Penerangan

Fungsi GW2RegisterAnalysisMemory mendaftarkan penimbal memori sebagai output untuk laporan analisis, bagi sesi yang ditentukan oleh session. Panggil GetAnalysisBuffer atau GetAnalysisReport selepas memanggil GW2RunSession untuk mendapatkan semula laporan analisis.

Rujuk API Overview/Return types untuk enumerator yang sah bagi format.

Pulangan

Fungsi GW2RegisterAnalysisMemory mengembalikan enumerasi GW2_RetStatus yang ditukarkan kepada int. Nilainya akan negatif jika ralat berlaku. 0 menunjukkan kejayaan. Rujuk API Overview/Return types untuk butiran lanjut.

Pengecualian GlasswallException akan dilemparkan jika session tidak sah.

Sinopsis - Dapatkan Data

import com.glasswall.core2javabridge.*;

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

Penerangan

Fungsi GetAnalysisBuffer mendapatkan kandungan penimbal laporan analisis yang dikaitkan dengan sesi yang ditentukan oleh session.

Pulangan

Fungsi GetAnalysisBuffer mengembalikan Byte[] yang mengandungi laporan analisis. Fungsi GetAnalysisReport mengembalikan String yang mengandungi laporan analisis. Nilai ini akan menjadi null jika kedua-dua GW2RunSession dan GW2RegisterAnalysisMemory belum dipanggil.

Pengecualian GlasswallException akan dilemparkan jika session tidak sah.

Sinopsis

Mendaftarkan fail analisis untuk session yang diberikan. Fail analisis akan dicipta semasa panggilan run_session 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.
    """

Pulangan

gw_return_object (glasswall.GwReturnObj): Instance GwReturnObj dengan atribut 'status', 'session', 'analysis_format'. Jika output_file ialah None (mod memori), 'buffer' dan 'buffer_length' disertakan yang mengandungi kandungan fail dan saiz fail. Jika output_file bukan None (mod fail) 'output_file' disertakan.

Atribut status ialah nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.

Sinopsis

Fungsi ini menyimpan penuding kepada laporan analisis yang dihasilkan oleh pelaksanaan runSession yang berjaya.

/**
 *
 * @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)

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.