GW2RegisterExportFile

Sinopsis

Fungsi GW2RegisterExportFile mendaftarkan fail yang namanya ialah rentetan yang ditunjukkan oleh exportFilePath dengan sesi yang ditandakan oleh session. Data yang dieksport akan diletakkan dalam fail tersebut. Penggunaan fungsi ini mengaktifkan Export Process Mode untuk sesi tersebut.

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

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.

Sinopsis

public int RegisterExportFile(
    int session,
    string exportFilePath)

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.

Sinopsis

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

Nota

Parameter fungsi GW2RegisterExportFile telah dikemas kini untuk menggunakan String menggantikan byte[]. Fungsi asal telah ditamatkan penggunaan.

Pulangan

Fungsi GW2RegisterExportFile 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 exportFilePath ialah null atau kosong.

Pengecualian GlasswallException akan dilemparkan jika session tidak sah, jika exportFilePath tidak dapat diperoleh, atau jika exportFilePath tidak dapat ditukarkan kepada UTF-8.

Sinopsis

Mendaftarkan fail untuk dieksport bagi sesi yang diberikan. Fail eksport akan dicipta semasa panggilan run_session sesi tersebut.

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

Pulangan

gw_return_object (glasswall.GwReturnObj): Instance GwReturnObj dengan atribut 'status' yang menunjukkan hasil panggilan fungsi dan 'session', iaitu integer session. Jika output_file ialah None (mod memori), 'buffer' dan 'buffer_length' disertakan yang mengandungi kandungan fail dan saiz fail.

Atribut status ialah nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.

Sinopsis

Fungsi ini mendaftarkan fail eksport yang ditentukan dengan session yang ditentukan

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

GW2RegisterExportFile(session, exportFilePath)

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.