GW2RegisterAnalysisFile

Sinopsis

Fungsi GW2RegisterAnalysisFile menyimpan laporan analisis yang dihasilkan oleh eksekusi berhasil dari fungsi API runSession yang menggunakan session session ke dalam file yang namanya ditunjuk oleh string analysisFilePath. Menggunakan fungsi ini mengaktifkan Analysis Process Mode untuk session tersebut.

#include "glasswall.core2.api.h"
int GW2RegisterAnalysisFile(Session session,
                            const char *analysisFilePath,
                            Analysis_format format);

Hasil pengembalian

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

Contoh

    #include "glasswall.core2.api.h"

    Session session = GW2OpenSession();
    if (!session)
        /* deal with error */
    else
        if (GW2RegisterAnalysisFile(session, "c:\\analysis_files\\analysis_file_023.xml", AF_XML) < 0)
            /* deal with error */
        else
            /* analysis file registered */

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

Sinopsis

public int RegisterAnalysisFile(
    int session,
    string analysisFilePath,
    int analysisFormat)

Hasil pengembalian

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

Sinopsis

import com.glasswall.core2javabridge.*;

public int GW2RegisterAnalysisFile(int session, String analysisFilePath, int format) throws GlasswallException, NullPointerException

(Deprecated)
public int GW2RegisterAnalysisFile(int session, byte[] analysisFilePath, int format) throws GlasswallException, NullPointerException

Catatan

Parameter fungsi GW2RegisterAnalysisFile telah diperbarui untuk menggunakan String sebagai pengganti byte[]. Fungsi aslinya telah deprecated.

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

Hasil pengembalian

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

Exception NullPointerException akan dilempar jika analysisFilePath bernilai null atau kosong.

Exception GlasswallException akan dilempar jika session tidak valid, atau jika analysisFilePath tidak dapat diambil.

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 mendaftarkan file yang ditentukan dengan session yang ditentukan, sesuai dengan format yang ditentukan

/**
 *
 * @param {number} session The ID of the session.
 * @param {string} analysisFilePathName The path of the file to be registered.
 * @param {number} format The specified format.
 */

GW2RegisterAnalysisFile(
    session,
    analysisFilePathName,
    format)

Hasil pengembalian

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