GW2RegisterImportFile

Tóm tắt

Hàm GW2RegisterImportFile đăng ký tệp có tên được trỏ tới bởi importFilePath làm tệp cần nhập. Tệp phải tuân thủ định dạng tệp trao đổi. Việc sử dụng hàm này sẽ kích hoạt Chế độ Quy trình Nhập cho phiên.

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

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 RegisterImportFile(
    int session,
    string importFilePath)

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 GW2RegisterImportFile(int session, String importFilePath) throws GlasswallException, NullPointerException

(deprecated)
public int GW2RegisterImportFile(int session, byte[] importFilePath) throws GlasswallException, NullPointerException

Lưu ý

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

Giá trị trả về

Hàm GW2RegisterImportFile 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 importFilePath 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 importFilePath, hoặc nếu không thể chuyển đổi importFilePath sang UTF-8.

Tóm tắt

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

def register_import(self, session: int, input_file: Union[str, bytes, bytearray, io.BytesIO]):
    """ Registers a .zip file to be imported for the given session. The constructed file will be created during the session's run_session call.

    Args:
        session (int): The session integer.
        input_file (Union[str, bytes, bytearray, io.BytesIO]): The input import file path or bytes.

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

Giá trị trả về

gw_return_object (glasswall.GwReturnObj): Một thể hiện GwReturnObj với thuộc tính 'status' cho biết kết quả của lệnh gọi hàm. 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 đường dẫn tệp nhập với một session được chỉ định.

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

GW2RegisterImportFile(session, importFilePath)

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.