Ikhtisar API
Jenis
API menyediakan tiga enumerasi untuk digunakan oleh klien sebagai tipe argumen untuk fungsi API tertentu. Sertakan file header glasswall.core2.api.h dalam file sumber Anda dan gunakan enumerator saat memanggil fungsi API.
Policy_format
Enumerasi Policy_format digunakan untuk menentukan format file policy. Enumerator berikut tersedia:
PF_XML
Analysis_format
Enumerasi Analysis_format digunakan untuk menentukan format file analisis. Enumerator berikut tersedia:
AF_XML
ft_t
Enumerasi ft_t digunakan untuk menunjukkan jenis file (format file) dari suatu file. Sertakan file header filetype.h dalam file kode sumber Anda untuk menggunakannya.
Tipe pengembalian
Sebagian besar fungsi dalam Glasswall API mengembalikan nilai yang menunjukkan keberhasilan atau kegagalan. Nilai-nilai tersebut dan artinya tercantum di bawah ini.
| Nilai | Nama sistem | Arti | Respons pemrosesan |
|---|---|---|---|
| 1 | gw2ret_ok_withcleaning | File berhasil diproses. Sanitasi atau remediasi, atau keduanya, telah diterapkan. | File terkelola dihasilkan |
| 0 | gw2ret_ok | File berhasil diproses. Tidak ada sanitasi atau remediasi yang diterapkan. | File terkelola dihasilkan |
| -1 | gw2ret_generalfail | Kegagalan umum selama pemrosesan, masalah sistem atau sumber daya | Kesalahan Engine. |
| -2 | gw2ret_unexpectedEndOfFile | Akhir file, atau penanda akhir file terdeteksi secara tidak terduga. | File diproses tetapi dibuang. |
| -3 | gw2ret_licenseExpired | File lisensi kedaluwarsa, data salah atau hilang. | Kesalahan Engine. |
| -4 | gw2ret_incorrectSessionSetup | Pengaturan file policy bukan nilai yang valid (lihat XSD). Atau registrasi tidak kompatibel. Misalnya, mencoba mendaftarkan file input dan buffer input ketika Anda hanya dapat memiliki satu sumber. | Kesalahan Engine. |
| -5 | gw2ret_incorrectPolicySetup | File policy tidak dapat dimuat atau terjadi kesalahan konten. | Kesalahan Engine. |
| -6 | gw2ret_unableToLoadInput | Tidak dapat memuat file input atau mengakses buffer yang memuatnya. | Kesalahan Engine. |
| -7 | gw2ret_fileTypeUnknown | Tidak dapat menentukan jenis file | File tidak dikenali. |
| -8 | gw2ret_unknownSessionID | Session ID yang digunakan dalam panggilan API tidak muncul dalam daftar Session aktif. Session tersebut belum dibuat atau sudah dihapus. | Kesalahan Engine. |
| -9 | gw2ret_argumentError | Salah satu argumen dalam panggilan API tidak valid. | Kesalahan Engine. |
| -10 | gw2ret_unableToLoadImport | Tidak dapat memuat file data impor atau mengakses buffer yang memuatnya. | Kesalahan Engine. |
| -11 | gw2ret_cameraDidNotInitialise | Plugin kamera gagal diinisialisasi. | Kesalahan Engine. |
| -12 | gw2ret_noCamerasConnected | Tidak ada plugin kamera yang telah dimuat. | Kesalahan Engine. |
| -13 | gw2ret_engineeringOnlyGoesToFile | Tidak digunakan. Dicadangkan untuk penggunaan di masa mendatang. | Kesalahan Engine. |
| -14 | gw2ret_unableToWriteOutput | Tidak dapat menulis file output atau buffer yang mengharapkannya. | Kesalahan Engine. |
| -15 | gw2ret_unableToWriteExport | Tidak dapat menulis file data ekspor atau buffer yang mengharapkannya. | Kesalahan Engine. |
| -16 | gw2ret_fileRejected | File berhasil diproses tetapi tidak diizinkan oleh pengaturan policy. Lihat analisis atau panggilan API GW2FileErrorMsg. | File diproses tetapi dibuang. |
| -17 | gw2ret_unableToWriteExportTextDump | Tidak dapat menulis file output ekspor teks. | Kesalahan Engine. |
| -18 | gw2ret_unableToWriteAnalysisReport | Tidak dapat menulis file output laporan analisis. | Kesalahan Engine. |
| -19 | gw2ret_inputTooLarge | Ukuran file input melebihi batas 2GiB. | File tidak valid. |
| -20 | gw2ret_inputZeroBytes | Ukuran file input adalah 0 byte. | File tidak valid. |
Bersih dikenali
| Nilai | Nama sistem |
|---|---|
| 1 | gw2ret_ok_withcleaning |
| 0 | gw2ret_ok |
CorruptedRecognised
| Nilai | Nama sistem |
|---|---|
| -2 | gw2ret_unexpectedEndOfFile |
| -16 | gw2ret_fileRejected |
File tidak dikenali
| Nilai | Nama sistem |
|---|---|
| -7 | gw2ret_fileTypeUnknown |
Kesalahan 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 |
File tidak valid
| Nilai | Nama sistem |
|---|---|
| -19 | gw2ret_inputTooLarge |
| -20 | gw2ret_inputZeroBytes |
Setiap fungsi yang dijelaskan dalam fungsi API mengasumsikan bahwa salah satu nilai ini dikembalikan kecuali dinyatakan lain dalam deskripsi terperinci.