GW2RegisterExportFile

概要

GW2RegisterExportFile 関数は、exportFilePath が指す文字列を名前とするファイルを、session. で示されるセッションに登録します。エクスポートされたデータはそのファイルに配置されます。この関数を使用すると、そのセッションの Export Process Mode が有効になります。

#include "glasswall.core2.api.h"
int GW2RegisterExportFile(
    Session session,
    const char *exportFilePath);

戻り値

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

概要

public int RegisterExportFile(
    int session,
    string exportFilePath)

戻り値

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

概要

import com.glasswall.core2javabridge.*;

public int GW2RegisterExportFile(int session, String exportFilePath) throws GlasswallException, NullPointerException

(Deprecated)
public int GW2RegisterExportFile(int session, byte[] exportFilePath) throws GlasswallException, NullPointerException

注

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

戻り値

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

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

A GlasswallException exception will be thrown if session is invalid, if the exportFilePath could not be retrieved, or if the exportFilePath could not be converted to UTF-8.

概要

指定された session に対して、エクスポートするファイルを登録します。エクスポートファイルは、その session の run_session 呼び出し中に作成されます。

def register_export(self, session: int, output_file: Optional[str] = None):
    """ Registers a file to be exported for the given session. The export 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 export will be written. None exports the file in memory.

    Returns:
        gw_return_object (glasswall.GwReturnObj): A GwReturnObj instance with the attribute 'status' indicating the result of the function call and 'session', the session integer. If output_file is None (memory mode), 'buffer', and 'buffer_length' are included containing the file content and file size.
    """

戻り値

gw_return_object (glasswall.GwReturnObj): 属性 'status' が関数呼び出しの結果を示し、'session' が session の整数値を示す GwReturnObj インスタンスです。output_file が None（メモリモード）の場合、ファイル内容とファイルサイズを含む 'buffer' および 'buffer_length' も含まれます。

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

概要

この関数は、指定されたエクスポートファイルを指定された session に登録します

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

GW2RegisterExportFile(session, exportFilePath)

戻り値

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