Tổng quan API
Các kiểu
API cung cấp ba kiểu liệt kê để client sử dụng làm kiểu đối số cho một số hàm API nhất định. Hãy đưa tệp tiêu đề glasswall.core2.api.h vào tệp mã nguồn của bạn và sử dụng các giá trị liệt kê khi gọi các hàm API.
Policy_format
Kiểu liệt kê Policy_format được dùng để chỉ định định dạng của tệp policy. Có sẵn giá trị liệt kê sau:
PF_XML
Analysis_format
Kiểu liệt kê Analysis_format được dùng để chỉ định định dạng của tệp phân tích. Có sẵn giá trị liệt kê sau:
AF_XML
ft_t
Kiểu liệt kê ft_t được dùng để biểu thị loại tệp (định dạng tệp) của một tệp. Hãy đưa tệp tiêu đề filetype.h vào các tệp mã nguồn của bạn để sử dụng chúng.
Kiểu trả về
Hầu hết các hàm trong API Glasswall trả về một giá trị cho biết thành công hay thất bại. Các giá trị và ý nghĩa của chúng được liệt kê bên dưới.
| Giá trị | Tên hệ thống | Ý nghĩa | Phản hồi xử lý |
|---|---|---|---|
| 1 | gw2ret_ok_withcleaning | Tệp đã được xử lý thành công. Các thao tác làm sạch hoặc khắc phục, hoặc cả hai, đã được áp dụng. | Đã tạo tệp được quản lý |
| 0 | gw2ret_ok | Tệp đã được xử lý thành công. Không có thao tác làm sạch hoặc khắc phục nào được áp dụng. | Đã tạo tệp được quản lý |
| -1 | gw2ret_generalfail | Lỗi chung trong quá trình xử lý, sự cố hệ thống hoặc tài nguyên | Lỗi Engine. |
| -2 | gw2ret_unexpectedEndOfFile | Đã phát hiện kết thúc tệp hoặc dấu kết thúc tệp một cách không mong đợi. | Tệp đã được xử lý nhưng bị loại bỏ. |
| -3 | gw2ret_licenseExpired | Tệp giấy phép đã hết hạn, dữ liệu không chính xác hoặc bị thiếu. | Lỗi Engine. |
| -4 | gw2ret_incorrectSessionSetup | Một thiết lập trong tệp policy không phải là giá trị hợp lệ (xem XSD). Hoặc một đăng ký không tương thích. Ví dụ: cố gắng đăng ký một tệp đầu vào và bộ đệm đầu vào khi chỉ có thể có một nguồn. | Lỗi Engine. |
| -5 | gw2ret_incorrectPolicySetup | Không thể tải tệp policy hoặc có lỗi nội dung. | Lỗi Engine. |
| -6 | gw2ret_unableToLoadInput | Không thể tải tệp đầu vào hoặc truy cập bộ đệm chứa tệp đó. | Lỗi Engine. |
| -7 | gw2ret_fileTypeUnknown | Không thể xác định loại tệp | Tệp không được nhận dạng. |
| -8 | gw2ret_unknownSessionID | Session ID được sử dụng trong lệnh gọi API không xuất hiện trong danh sách các Session đang hoạt động. Session chưa được tạo hoặc đã bị xóa. | Lỗi Engine. |
| -9 | gw2ret_argumentError | Một trong các đối số trong lệnh gọi API không hợp lệ. | Lỗi Engine. |
| -10 | gw2ret_unableToLoadImport | Không thể tải tệp dữ liệu import hoặc truy cập bộ đệm chứa tệp đó. | Lỗi Engine. |
| -11 | gw2ret_cameraDidNotInitialise | Một plugin camera không khởi tạo được. | Lỗi Engine. |
| -12 | gw2ret_noCamerasConnected | Không có plugin camera nào được tải. | Lỗi Engine. |
| -13 | gw2ret_engineeringOnlyGoesToFile | Không sử dụng. Dành riêng cho mục đích sử dụng trong tương lai. | Lỗi Engine. |
| -14 | gw2ret_unableToWriteOutput | Không thể ghi tệp đầu ra hoặc bộ đệm đang chờ nhận tệp đó. | Lỗi Engine. |
| -15 | gw2ret_unableToWriteExport | Không thể ghi tệp dữ liệu xuất hoặc bộ đệm đang chờ nhận tệp đó. | Lỗi Engine. |
| -16 | gw2ret_fileRejected | Tệp đã được Processed thành công nhưng không được policy cho phép. Xem phân tích hoặc lệnh gọi API GW2FileErrorMsg. | Tệp đã được xử lý nhưng bị loại bỏ. |
| -17 | gw2ret_unableToWriteExportTextDump | Không thể ghi tệp đầu ra xuất văn bản. | Lỗi Engine. |
| -18 | gw2ret_unableToWriteAnalysisReport | Không thể ghi tệp đầu ra báo cáo phân tích. | Lỗi Engine. |
| -19 | gw2ret_inputTooLarge | Kích thước tệp đầu vào vượt quá giới hạn 2GiB. | Tệp không hợp lệ. |
| -20 | gw2ret_inputZeroBytes | Kích thước tệp đầu vào là 0 byte. | Tệp không hợp lệ. |
Đã làm sạch và nhận diện
| Giá trị | Tên hệ thống |
|---|---|
| 1 | gw2ret_ok_withcleaning |
| 0 | gw2ret_ok |
Đã nhận diện bị hỏng
| Giá trị | Tên hệ thống |
|---|---|
| -2 | gw2ret_unexpectedEndOfFile |
| -16 | gw2ret_fileRejected |
Tệp không được nhận diện
| Giá trị | Tên hệ thống |
|---|---|
| -7 | gw2ret_fileTypeUnknown |
Lỗi Engine
| Giá trị | Tên hệ thống |
|---|---|
| -1 | gw2ret_generalfail |
| -3 | gw2ret_licenseExpired |
| -4 | gw2ret_incorrectSessionSetup |
| -5 | gw2ret_incorrectPolicySetup |
| -6 | gw2ret_unableToLoadInput |
| -8 | gw2ret_unknownSessionID |
| -9 | gw2ret_argumentError |
| -10 | gw2ret_unableToLoadImport |
| -11 | gw2ret_cameraDidNotInitialise |
| -12 | gw2ret_noCamerasConnected |
| -13 | gw2ret_engineeringOnlyGoesToFile |
| -14 | gw2ret_unableToWriteOutput |
| -15 | gw2ret_unableToWriteExport |
| -17 | gw2ret_unableToWriteExportTextDump |
| -18 | gw2ret_unableToWriteAnalysisReport |
Tệp không hợp lệ
| Giá trị | Tên hệ thống |
|---|---|
| -19 | gw2ret_inputTooLarge |
| -20 | gw2ret_inputZeroBytes |
Mỗi hàm được mô tả trong các hàm API đều giả định rằng một trong các giá trị này sẽ được trả về, trừ khi có nêu khác đi trong phần mô tả chi tiết.