GW2RegisterAnalysisFile

概要

GW2RegisterAnalysisFile 関数は、文字列 analysisFilePath が指す名前のファイルに、セッション session を使用して API 関数 runSession が正常に実行された際に生成された分析レポートを保存します。この関数を使用すると、そのセッションの Analysis Process Mode が有効になります。

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

戻り値

整数の GW2_RetStatus 列挙値を返します。負の数は失敗を示します。

例

    #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 */

概要

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

戻り値

整数の GW2_RetStatus 列挙値を返します。負の数は失敗を示します。

概要

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

注

The GW2RegisterAnalysisFile function parameters have been updated to use String in place of byte[]. The original function has been deprecated.

format の有効な列挙子については、API Overview/Return types を参照してください。

戻り値

GW2RegisterAnalysisFile 関数は、GW2_RetStatus 列挙型を int に変換して返します。エラーが発生した場合、値は負になります。0 は成功を示します。詳細については、API Overview/Return types を参照してください。

NullPointerException 例外は、analysisFilePath が null または空の場合にスローされます。

GlasswallException 例外は、session が無効である場合、または analysisFilePath を取得できなかった場合にスローされます。

概要

指定されたセッションに対して分析ファイルを登録します。分析ファイルは、そのセッションの run_session 呼び出し中に作成されます。

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.
    """

戻り値

gw_return_object (glasswall.GwReturnObj): 属性 'status'、'session'、'analysis_format' を持つ GwReturnObj インスタンスです。output_file が None の場合（メモリモード）、ファイル内容とファイルサイズを含む 'buffer' および 'buffer_length' が含まれます。output_file が None でない場合（ファイルモード）、'output_file' が含まれます。

status 属性は整数の GW2_RetStatus enum 値です。負の数は失敗を示します。

概要

この関数は、指定された形式に従って、指定されたファイルを指定されたセッションに登録します

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

戻り値

整数の GW2_RetStatus 列挙値を返します。負の数は失敗を示します。