GW2RegisterExportFile

Sinopsis

Fungsi GW2RegisterExportFile mendaftarkan file yang namanya adalah string yang ditunjuk oleh exportFilePath ke sesi yang ditandai oleh session. Data yang diekspor akan ditempatkan di file tersebut. Menggunakan fungsi ini mengaktifkan Export Process Mode untuk sesi tersebut.

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

Hasil pengembalian

Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.

Sinopsis

public int RegisterExportFile(
    int session,
    string exportFilePath)

Hasil pengembalian

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

Catatan

Parameter fungsi GW2RegisterExportFile telah diperbarui untuk menggunakan String sebagai pengganti byte[]. Fungsi aslinya telah ditandai usang.

Hasil pengembalian

Fungsi GW2RegisterExportFile mengembalikan enumerasi GW2_RetStatus yang dikonversi menjadi int. Nilainya akan negatif jika terjadi kesalahan. 0 menunjukkan keberhasilan. Lihat API Overview/Return types untuk detailnya.

Pengecualian NullPointerException akan dilempar jika exportFilePath bernilai null atau kosong.

Pengecualian GlasswallException akan dilempar jika session tidak valid, jika exportFilePath tidak dapat diambil, atau jika exportFilePath tidak dapat dikonversi ke UTF-8.

Sinopsis

Mendaftarkan file untuk diekspor bagi session yang diberikan. File ekspor akan dibuat selama pemanggilan run_session pada session 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.
    """

Hasil pengembalian

gw_return_object (glasswall.GwReturnObj): Instance GwReturnObj dengan atribut 'status' yang menunjukkan hasil pemanggilan fungsi dan 'session', yaitu bilangan bulat session. Jika output_file adalah None (mode memori), 'buffer' dan 'buffer_length' disertakan yang berisi konten file dan ukuran file.

Atribut status adalah nilai enum bilangan bulat GW2_RetStatus. Angka negatif menunjukkan kegagalan.

Sinopsis

Fungsi ini mendaftarkan file ekspor 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)

Hasil pengembalian

Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.