GW2RegisterOutFile

Sinopsis

Untuk sesi session, fungsi GW2RegisterOutFile mendaftarkan file yang namanya adalah string yang ditunjuk oleh outputFileBuffer sebagai file tujuan untuk file terkelola yang dihasilkan oleh Glasswall. Base name dari path harus berbeda dari base name yang didaftarkan menggunakan fungsi GW2RegisterInputFile. Menggunakan fungsi ini mengaktifkan Manage & Protect Process Mode untuk sesi tersebut.

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

Hasil pengembalian

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

Contoh

    #include "glasswall.core2.api.h"

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

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

Sinopsis

public int RegisterOutFile(
    int session,
    string outputFilePath)

Hasil pengembalian

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

Sinopsis

import com.glasswall.core2javabridge.*;

public int GW2RegisterOutFile(int session, String outputFilePath) throws GlasswallException, NullPointerException

(Deprecated)
public int GW2RegisterOutFile(int session, byte[] outputFilePath) throws GlasswallException, NullPointerException

Catatan

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

Hasil pengembalian

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

Exception NullPointerException akan dilempar jika outputFilePath bernilai null atau kosong.

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

Sinopsis

Daftarkan file output untuk sesi yang diberikan. Jika output_file adalah None, file akan dikembalikan sebagai atribut 'buffer' dan 'buffer_length'.

def register_output(self, session, output_file: Optional[str] = None):
    """ Register an output file for the given session. If output_file is None the file will be returned as 'buffer' and 'buffer_length' attributes.

    Args:
        session (int): The session integer.
        output_file (Optional[str]): If specified, during run session the file will be written to output_file, otherwise the file will be written to the glasswall.GwReturnObj 'buffer' and 'buffer_length' attributes.

    Returns:
        gw_return_object (glasswall.GwReturnObj): A GwReturnObj instance with the attribute 'status' indicating the result of the function call. 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. 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 tujuan untuk file terkelola yang dihasilkan oleh Glasswall.

/**
 * @param {number} session The ID of the session.
 * @param {string} outputFilePath The specified output path. Must be different to the specified input file path.
 */

GW2RegisterOutFile(
    session,
    outputFilePath)

Hasil pengembalian

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