ภาพรวม API
ประเภท
API มีการจัดเตรียม enumeration สามรายการไว้ให้ไคลเอนต์ใช้เป็นชนิดอาร์กิวเมนต์สำหรับฟังก์ชัน API บางรายการ ให้รวมไฟล์ส่วนหัว glasswall.core2.api.h ไว้ในไฟล์ซอร์สของคุณ และใช้ enumerator เมื่อเรียกใช้ฟังก์ชัน API
Policy_format
enumeration Policy_format ใช้เพื่อระบุรูปแบบของไฟล์ policies โดยมี enumerator ต่อไปนี้ให้ใช้งาน:
PF_XML
Analysis_format
enumeration Analysis_format ใช้เพื่อระบุรูปแบบของไฟล์ analysis โดยมี enumerator ต่อไปนี้ให้ใช้งาน:
AF_XML
ft_t
enumeration ft_t ใช้เพื่อระบุชนิดไฟล์ (รูปแบบไฟล์) ของไฟล์ ให้รวมไฟล์ส่วนหัว filetype.h ไว้ในไฟล์ซอร์สโค้ดของคุณเพื่อใช้งาน
ชนิดค่าที่ส่งกลับ
ฟังก์ชันส่วนใหญ่ใน Glasswall API จะส่งกลับค่าที่ระบุถึงความสำเร็จหรือความล้มเหลว โดยค่าต่าง ๆ และความหมายของค่าเหล่านั้นแสดงไว้ด้านล่าง
| ค่า | ชื่อระบบ | ความหมาย | การตอบสนองการประมวลผล |
|---|---|---|---|
| 1 | gw2ret_ok_withcleaning | ไฟล์ได้รับการประมวลผลสำเร็จแล้ว มีการใช้การทำให้ปลอดภัยหรือการแก้ไข หรือทั้งสองอย่าง | สร้างไฟล์ที่จัดการแล้ว |
| 0 | gw2ret_ok | ไฟล์ได้รับการประมวลผลสำเร็จแล้ว ไม่มีการใช้การทำให้ปลอดภัยหรือการแก้ไข | สร้างไฟล์ที่จัดการแล้ว |
| -1 | gw2ret_generalfail | เกิดความล้มเหลวทั่วไประหว่างการประมวลผล เป็นปัญหาของระบบหรือทรัพยากร | ข้อผิดพลาดของ Engine |
| -2 | gw2ret_unexpectedEndOfFile | ตรวจพบจุดสิ้นสุดของไฟล์ หรือเครื่องหมายสิ้นสุดไฟล์โดยไม่คาดคิด | ไฟล์ได้รับการประมวลผลแล้วแต่ถูกทิ้ง |
| -3 | gw2ret_licenseExpired | ไฟล์ใบอนุญาตหมดอายุ ข้อมูลไม่ถูกต้องหรือขาดหายไป | ข้อผิดพลาดของ Engine |
| -4 | gw2ret_incorrectSessionSetup | การตั้งค่าในไฟล์ policy ค่าใดค่าหนึ่งไม่ใช่ค่าที่ถูกต้อง (ดู XSD) หรือการลงทะเบียนไม่เข้ากัน เช่น พยายามลงทะเบียนทั้งไฟล์อินพุตและบัฟเฟอร์อินพุต ทั้งที่สามารถมีแหล่งข้อมูลได้เพียงแหล่งเดียว | ข้อผิดพลาดของ Engine |
| -5 | gw2ret_incorrectPolicySetup | ไม่สามารถโหลดไฟล์ policy ได้ หรือมีข้อผิดพลาดของเนื้อหา | ข้อผิดพลาดของ Engine |
| -6 | gw2ret_unableToLoadInput | ไม่สามารถโหลดไฟล์อินพุตหรือเข้าถึงบัฟเฟอร์ที่มีไฟล์ดังกล่าวได้ | ข้อผิดพลาดของ Engine |
| -7 | gw2ret_fileTypeUnknown | ไม่สามารถระบุประเภทไฟล์ได้ | ไม่รู้จักไฟล์ |
| -8 | gw2ret_unknownSessionID | Session ID ที่ใช้ในการเรียก API ไม่ปรากฏในรายการ Sessions ที่ใช้งานอยู่ Session อาจยังไม่ได้ถูกสร้างหรือถูกลบไปแล้ว | ข้อผิดพลาดของ Engine |
| -9 | gw2ret_argumentError | หนึ่งในอาร์กิวเมนต์ในการเรียก API ไม่ถูกต้อง | ข้อผิดพลาดของ Engine |
| -10 | gw2ret_unableToLoadImport | ไม่สามารถโหลดไฟล์ข้อมูลนำเข้าหรือเข้าถึงบัฟเฟอร์ที่มีไฟล์ดังกล่าวได้ | ข้อผิดพลาดของ Engine |
| -11 | gw2ret_cameraDidNotInitialise | ปลั๊กอินกล้องตัวหนึ่งไม่สามารถเริ่มต้นการทำงานได้ | ข้อผิดพลาดของ Engine |
| -12 | gw2ret_noCamerasConnected | ยังไม่มีการโหลดปลั๊กอินกล้องใด ๆ | ข้อผิดพลาดของ Engine |
| -13 | gw2ret_engineeringOnlyGoesToFile | ไม่ได้ใช้งาน สงวนไว้สำหรับการใช้งานในอนาคต | ข้อผิดพลาดของ Engine |
| -14 | gw2ret_unableToWriteOutput | ไม่สามารถเขียนไฟล์เอาต์พุตหรือบัฟเฟอร์ที่รองรับไฟล์นั้นได้ | ข้อผิดพลาดของ Engine |
| -15 | gw2ret_unableToWriteExport | ไม่สามารถเขียนไฟล์ข้อมูล export หรือบัฟเฟอร์ที่รองรับไฟล์นั้นได้ | ข้อผิดพลาดของ Engine |
| -16 | gw2ret_fileRejected | ไฟล์ถูก Processed สำเร็จแล้ว แต่ไม่ได้รับอนุญาตตามการตั้งค่า policy โปรดดูการวิเคราะห์หรือการเรียก API GW2FileErrorMsg | ไฟล์ได้รับการประมวลผลแล้วแต่ถูกทิ้ง |
| -17 | gw2ret_unableToWriteExportTextDump | ไม่สามารถเขียนไฟล์เอาต์พุต text export ได้ | ข้อผิดพลาดของ Engine |
| -18 | gw2ret_unableToWriteAnalysisReport | ไม่สามารถเขียนไฟล์เอาต์พุตรายงานการวิเคราะห์ได้ | ข้อผิดพลาดของ Engine |
| -19 | gw2ret_inputTooLarge | ขนาดไฟล์อินพุตเกินขีดจำกัด 2GiB | ไฟล์ไม่ถูกต้อง |
| -20 | gw2ret_inputZeroBytes | ขนาดไฟล์อินพุตเป็น 0 ไบต์ | ไฟล์ไม่ถูกต้อง |
สะอาดและรู้จัก
| ค่า | ชื่อระบบ |
|---|---|
| 1 | gw2ret_ok_withcleaning |
| 0 | gw2ret_ok |
CorruptedRecognised
| ค่า | ชื่อระบบ |
|---|---|
| -2 | gw2ret_unexpectedEndOfFile |
| -16 | gw2ret_fileRejected |
ไฟล์ที่ไม่รู้จัก
| ค่า | ชื่อระบบ |
|---|---|
| -7 | gw2ret_fileTypeUnknown |
ข้อผิดพลาดของ Engine
| ค่า | ชื่อระบบ |
|---|---|
| -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 |
ไฟล์ไม่ถูกต้อง
| ค่า | ชื่อระบบ |
|---|---|
| -19 | gw2ret_inputTooLarge |
| -20 | gw2ret_inputZeroBytes |
แต่ละฟังก์ชันที่อธิบายไว้ใน ฟังก์ชัน API ถือว่าหนึ่งในค่าเหล่านี้จะถูกส่งกลับ เว้นแต่จะระบุไว้เป็นอย่างอื่นในคำอธิบายโดยละเอียด