GW2RegisterExportMemory
Fungsi GW2RegisterExportMemory mendaftarkan lokasi memori untuk menyimpan file yang diekspor. Menggunakan fungsi ini mengaktifkan Export Process Mode untuk session.
- C++
- C#
- Java
- Python
- JavaScript
Sinopsis
Untuk session session, fungsi GW2RegisterExportMemory mendaftarkan tempat konten yang diekspor akan diletakkan, dan tempat untuk menaruh ukuran dalam byte dari konten yang diekspor. Pointer ke konten yang diekspor akan ditempatkan dalam objek yang ditunjuk oleh exportFileBuffer dan ukuran dalam byte dari data yang diekspor akan ditempatkan dalam objek size_t yang ditunjuk oleh exportFileBufferLength. Konten yang diekspor akan dihapus saat session ditutup menggunakan GW2CloseSession. Menggunakan fungsi ini mengaktifkan Export Process Mode untuk session.
#include "glasswall.core2.api.h"
int GW2RegisterExportMemory(Session session,
char **exportFileBuffer,
size_t *exportFileBufferLength);
Hasil pengembalian
Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.
Sinopsis
public int RegisterExportMemory(
int session,
out IntPtr exportFileBufferPtr,
ref UIntPtr exportBufferLengthPtr)
Hasil pengembalian
Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.
Sinopsis
import com.glasswall.core2javabridge.*;
public int GW2RegisterExportMemory(int session) throws GlasswallException
Deskripsi
Fungsi GW2RegisterExportMemory mendaftarkan buffer memori untuk digunakan sebagai output bagi file yang diekspor, untuk sesi yang ditentukan oleh session. Panggil GetExportBuffer setelah memanggil GW2RunSession untuk mengambil data hasil ekspor.
Hasil pengembalian
Fungsi GW2RegisterExportMemory 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 GlasswallException akan dilempar jika session tidak valid.
Sinopsis - Ambil Data
import com.glasswall.core2javabridge.*;
public byte[] GetExportBuffer(int session) throws GlasswallException
Deskripsi
Fungsi GetExportBuffer mengambil isi buffer ekspor yang terkait dengan sesi yang ditentukan oleh session.
Hasil pengembalian
Fungsi GetExportBuffer mengembalikan byte[] yang berisi file hasil ekspor. Nilainya akan null jika GW2RegisterExportMemory dan GW2RunSession belum dipanggil, atau jika file tidak sesuai.
Pengecualian GlasswallException akan dilempar jika session tidak valid.
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 lokasi memori ekspor terhadap sesi yang ditentukan.
/**
*
* @param {number} session The ID of the session.
* @param {string} exportFileBuffer A pointer to the specified memory location.
* @param {number} exportLength The size of the file buffer.
*/
GW2RegisterExportMemory(session, exportFileBuffer, exportLength)
Hasil pengembalian
Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.