GW2RegisterInputFile

概要

GW2RegisterInputFile 関数は、セッション session において処理するファイルを登録します。ファイル名は、inputFilePath が指す文字列です。

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

戻り値

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

例

#include "glasswall.core2.api.h"

HANDLE session = GW2OpenSession();
if (!session)
    /* deal with error */
else
{
    if (GW2RegisterInputFile(session, "filename.doc") < 0)
        /* deal with error */
    else
        /* continue processing */
        ...
}

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

概要

public int RegisterInputFile(
    int session,
    string inputFilePath)

戻り値

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

概要

import com.glasswall.core2javabridge.*;

public int GW2RegisterInputFile(int session, String inputFilePath) throws GlasswallException, NullPointerException

(Deprecated)
public int GW2RegisterInputFile(int session, byte[] inputFilePath) throws GlasswallException, NullPointerException

注

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

戻り値

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

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

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

概要

指定されたセッションに対して入力ファイルまたはバイト列を登録します。

def register_input(self, session: int, input_file: Union[str, bytes, bytearray, io.BytesIO]):
    """ Register an input file or bytes for the given session.

    Args:
        session (int): The session integer.
        input_file (Union[str, bytes, bytearray, io.BytesIO]): The input file path or bytes.

    Returns:
        - result (glasswall.GwReturnObj): Depending on the input 'input_file':
            - If input_file is a str file path:
                - gw_return_object (glasswall.GwReturnObj): A GwReturnObj instance with the attributes 'session', 'input_file', 'status'.

            - If input_file is a file in memory:
                - gw_return_object (glasswall.GwReturnObj): A GwReturnObj instance with the attributes 'session', 'buffer', 'buffer_length', 'status'.
    """

戻り値

input_file の種類に応じて異なる属性を持つオブジェクト。

• If input_file is a str file path:
  • gw_return_object (glasswall.GwReturnObj): 属性 'session'、'input_file'、'status' を持つ GwReturnObj インスタンス。
• If input_file is a file in memory:
  • gw_return_object (glasswall.GwReturnObj): 'session'、'buffer'、'buffer_length'、'status' の属性を持つ GwReturnObj インスタンス。

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

概要

この関数は、指定されたファイルを指定されたセッションの入力ファイルとして登録します

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

GW2RegisterInputFile(session, inputFilePath)

戻り値

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