GW2RegisterExportFile

Tóm tắt

Hàm GW2RegisterExportFile đăng ký tệp có tên là chuỗi được trỏ tới bởi exportFilePath với phiên được biểu thị bởi session. Dữ liệu được xuất sẽ được đặt trong tệp đó. Việc sử dụng hàm này sẽ kích hoạt Export Process Mode cho phiên.

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

Giá trị trả về

Trả về một giá trị enum GW2_RetStatus dạng số nguyên. Các số âm cho biết thất bại.

Tóm tắt

public int RegisterExportFile(
    int session,
    string exportFilePath)

Giá trị trả về

Trả về một giá trị enum GW2_RetStatus dạng số nguyên. Các số âm cho biết thất bại.

Tóm tắt

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

Lưu ý

Các tham số của hàm GW2RegisterExportFile đã được cập nhật để sử dụng String thay cho byte[]. Hàm gốc đã bị ngừng sử dụng.

Giá trị trả về

Hàm GW2RegisterExportFile trả về một giá trị liệt kê GW2_RetStatus được chuyển đổi thành int. Giá trị sẽ là số âm nếu xảy ra lỗi. 0 cho biết thành công. Tham khảo API Overview/Return types để biết chi tiết.

Một ngoại lệ NullPointerException sẽ được ném ra nếu exportFilePath là null hoặc rỗng.

Một ngoại lệ GlasswallException sẽ được ném ra nếu session không hợp lệ, nếu không thể truy xuất exportFilePath, hoặc nếu không thể chuyển đổi exportFilePath sang UTF-8.

Tóm tắt

Đăng ký một tệp để xuất cho session đã cho. Tệp xuất sẽ được tạo trong lần gọi run_session của session.

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

Giá trị trả về

gw_return_object (glasswall.GwReturnObj): Một thực thể GwReturnObj với thuộc tính 'status' cho biết kết quả của lệnh gọi hàm và 'session', là số nguyên session. Nếu output_file là None (chế độ bộ nhớ), 'buffer' và 'buffer_length' sẽ được bao gồm, chứa nội dung tệp và kích thước tệp.

Thuộc tính status là một giá trị enum GW2_RetStatus kiểu số nguyên. Các số âm cho biết thất bại.

Tóm tắt

Hàm này đăng ký một tệp xuất được chỉ định với một session được chỉ định

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

GW2RegisterExportFile(session, exportFilePath)

Giá trị trả về

Trả về một giá trị enum GW2_RetStatus dạng số nguyên. Các số âm cho biết thất bại.