Gambaran keseluruhan API
Jenis
API menyediakan tiga enumerasi untuk digunakan oleh klien sebagai jenis argumen kepada fungsi API tertentu. Sertakan fail pengepala glasswall.core2.api.h dalam fail sumber anda dan gunakan enumerator apabila memanggil fungsi API.
Policy_format
Enumerasi Policy_format digunakan untuk menentukan format fail policies. Enumerator berikut tersedia:
PF_XML
Analysis_format
Enumerasi Analysis_format digunakan untuk menentukan format fail analysis. Enumerator berikut tersedia:
AF_XML
ft_t
Enumerasi ft_t digunakan untuk menunjukkan jenis fail (format fail) bagi sesuatu fail. Sertakan fail pengepala filetype.h dalam fail kod sumber anda untuk menggunakannya.
Jenis pulangan
Kebanyakan fungsi dalam Glasswall API memulangkan nilai yang menunjukkan kejayaan atau kegagalan. Nilai tersebut dan maksudnya disenaraikan di bawah.
| Nilai | Nama sistem | Maksud | Respons pemprosesan |
|---|---|---|---|
| 1 | gw2ret_ok_withcleaning | Fail telah diproses dengan berjaya. Sanitasi atau pemulihan, atau kedua-duanya, telah digunakan. | Fail terurus dihasilkan |
| 0 | gw2ret_ok | Fail telah diproses dengan berjaya. Tiada sanitasi atau pemulihan telah digunakan. | Fail terurus dihasilkan |
| -1 | gw2ret_generalfail | Kegagalan umum semasa pemprosesan, masalah sistem atau sumber | Ralat Engine. |
| -2 | gw2ret_unexpectedEndOfFile | Penghujung fail, atau penanda penghujung fail dikesan secara tidak dijangka. | Fail Diproses tetapi dibuang. |
| -3 | gw2ret_licenseExpired | Fail lesen tamat tempoh, data tidak betul atau tiada. | Ralat Engine. |
| -4 | gw2ret_incorrectSessionSetup | Tetapan fail policy bukan nilai yang sah (lihat XSD). Atau pendaftaran tidak serasi. Contohnya, cuba mendaftarkan fail input dan penimbal input sedangkan anda hanya boleh mempunyai satu sumber. | Ralat Engine. |
| -5 | gw2ret_incorrectPolicySetup | Fail policy tidak dapat dimuatkan atau ralat kandungan. | Ralat Engine. |
| -6 | gw2ret_unableToLoadInput | Tidak dapat memuatkan fail input atau mengakses penimbal yang mengandunginya. | Ralat Engine. |
| -7 | gw2ret_fileTypeUnknown | Tidak dapat menentukan jenis fail | Fail tidak dikenali. |
| -8 | gw2ret_unknownSessionID | ID Sesi yang digunakan dalam panggilan API tidak muncul dalam senarai Sesi aktif. Sesi sama ada belum dicipta atau telah dipadam. | Ralat Engine. |
| -9 | gw2ret_argumentError | Salah satu argumen dalam panggilan API adalah tidak sah. | Ralat Engine. |
| -10 | gw2ret_unableToLoadImport | Tidak dapat memuatkan fail data import atau mengakses penimbal yang mengandunginya. | Ralat Engine. |
| -11 | gw2ret_cameraDidNotInitialise | Plugin kamera gagal dimulakan. | Ralat Engine. |
| -12 | gw2ret_noCamerasConnected | Tiada plugin kamera telah dimuatkan. | Ralat Engine. |
| -13 | gw2ret_engineeringOnlyGoesToFile | Tidak digunakan. Dikhaskan untuk kegunaan masa hadapan. | Ralat Engine. |
| -14 | gw2ret_unableToWriteOutput | Tidak dapat menulis fail output atau penimbal yang menjangkakannya. | Ralat Engine. |
| -15 | gw2ret_unableToWriteExport | Tidak dapat menulis fail data eksport atau penimbal yang menjangkakannya. | Ralat Engine. |
| -16 | gw2ret_fileRejected | Fail telah diproses dengan jayanya tetapi tidak dibenarkan oleh tetapan policy. Lihat analisis atau panggilan API GW2FileErrorMsg. | Fail Diproses tetapi dibuang. |
| -17 | gw2ret_unableToWriteExportTextDump | Tidak dapat menulis fail output eksport teks. | Ralat Engine. |
| -18 | gw2ret_unableToWriteAnalysisReport | Tidak dapat menulis fail output laporan analisis. | Ralat Engine. |
| -19 | gw2ret_inputTooLarge | Saiz fail input melebihi had 2GiB. | Fail tidak sah. |
| -20 | gw2ret_inputZeroBytes | Saiz fail input ialah 0 bait. | Fail tidak sah. |
Bersih dikenali
| Nilai | Nama sistem |
|---|---|
| 1 | gw2ret_ok_withcleaning |
| 0 | gw2ret_ok |
CorruptedRecognised
| Nilai | Nama sistem |
|---|---|
| -2 | gw2ret_unexpectedEndOfFile |
| -16 | gw2ret_fileRejected |
Fail tidak dikenali
| Nilai | Nama sistem |
|---|---|
| -7 | gw2ret_fileTypeUnknown |
Ralat Engine
| Nilai | Nama sistem |
|---|---|
| -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 |
Fail tidak sah
| Nilai | Nama sistem |
|---|---|
| -19 | gw2ret_inputTooLarge |
| -20 | gw2ret_inputZeroBytes |
Setiap fungsi yang diterangkan dalam fungsi API mengandaikan bahawa salah satu nilai ini dikembalikan melainkan dinyatakan sebaliknya dalam penerangan terperinci.