GW2RegisterAnalysisFile

Sinopsis

Fungsi GW2RegisterAnalysisFile menyimpan dalam fail yang namanya ditunjukkan oleh rentetan analysisFilePath laporan analisis yang dihasilkan oleh pelaksanaan berjaya fungsi API runSession yang menggunakan session session. Penggunaan fungsi ini mengaktifkan Mod Proses Analisis untuk session tersebut.

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

Pulangan

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

Pulangan

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

Nota

Parameter fungsi GW2RegisterAnalysisFile telah dikemas kini untuk menggunakan String menggantikan byte[]. Fungsi asal telah ditandakan sebagai deprecated.

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

Pulangan

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

Pengecualian NullPointerException akan dilemparkan jika analysisFilePath adalah null atau kosong.

Pengecualian GlasswallException akan dilemparkan jika session tidak sah, atau jika analysisFilePath tidak dapat diperoleh.

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 mendaftarkan fail yang ditentukan dengan session yang ditentukan, selaras 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)

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.