Pangkalahatang-ideya ng API
Mga uri
Ginagawang available ng API ang tatlong enumeration para gamitin ng mga client bilang mga uri ng argument sa ilang function ng API. Isama ang header file na glasswall.core2.api.h sa iyong source file at gamitin ang mga enumerator kapag tinatawag ang mga function ng API.
Policy_format
Ginagamit ang enumeration na Policy_format upang tukuyin ang format ng policies file. Available ang sumusunod na enumerator:
PF_XML
Analysis_format
Ginagamit ang enumeration na Analysis_format upang tukuyin ang format ng analysis file. Available ang sumusunod na enumerator:
AF_XML
ft_t
Ginagamit ang enumeration na ft_t upang ipahiwatig ang uri ng file (format ng file) ng isang file. Isama ang header file na filetype.h sa iyong mga source code file upang magamit ang mga ito.
Mga uri ng return
Karamihan sa mga function sa Glasswall API ay nagbabalik ng value na nagpapahiwatig ng tagumpay o pagkabigo. Nakalista sa ibaba ang mga value at ang kahulugan ng mga ito.
| Value | Pangalan ng system | Kahulugan | Tugon sa pagproseso |
|---|---|---|---|
| 1 | gw2ret_ok_withcleaning | Matagumpay na naproseso ang file. Naipatupad ang mga sanitisation o remedy, o pareho. | Nabuong managed file |
| 0 | gw2ret_ok | Matagumpay na naproseso ang file. Walang sanitisation o remedy na naipatupad. | Nabuong managed file |
| -1 | gw2ret_generalfail | Pangkalahatang pagkabigo habang pinoproseso, isang problema sa system o resource | Error sa Engine. |
| -2 | gw2ret_unexpectedEndOfFile | Hindi inaasahang natukoy ang dulo ng file, o marker ng dulo ng file. | Naproseso ang file ngunit itinapon. |
| -3 | gw2ret_licenseExpired | Paso na ang license file, mali ang data o nawawala. | Error sa Engine. |
| -4 | gw2ret_incorrectSessionSetup | Ang isang setting sa policy file ay hindi wastong value (tingnan ang XSD). O hindi compatible ang isang registration. Hal., sinusubukang magrehistro ng input file at input buffer gayong iisang source lang ang maaaring gamitin. | Error sa Engine. |
| -5 | gw2ret_incorrectPolicySetup | Hindi ma-load ang policy file o may error sa content. | Error sa Engine. |
| -6 | gw2ret_unableToLoadInput | Hindi ma-load ang input file o ma-access ang buffer na naglalaman nito. | Error sa Engine. |
| -7 | gw2ret_fileTypeUnknown | Hindi matukoy ang uri ng file | Hindi nakikilalang file. |
| -8 | gw2ret_unknownSessionID | Ang Session ID na ginamit sa API call ay hindi lumabas sa listahan ng mga aktibong Session. Ang Session ay maaaring hindi nagawa o nabura na. | Error sa Engine. |
| -9 | gw2ret_argumentError | Isa sa mga argument sa isang API call ay hindi wasto. | Error sa Engine. |
| -10 | gw2ret_unableToLoadImport | Hindi ma-load ang import data file o ma-access ang buffer na naglalaman nito. | Error sa Engine. |
| -11 | gw2ret_cameraDidNotInitialise | Nabigong mag-initialize ang isang camera plugin. | Error sa Engine. |
| -12 | gw2ret_noCamerasConnected | Walang na-load na mga camera plugin. | Error sa Engine. |
| -13 | gw2ret_engineeringOnlyGoesToFile | Hindi ginagamit. Nakalaan para sa paggamit sa hinaharap. | Error sa Engine. |
| -14 | gw2ret_unableToWriteOutput | Hindi maisulat ang output file o ang buffer na naghihintay nito. | Error sa Engine. |
| -15 | gw2ret_unableToWriteExport | Hindi maisulat ang export data file o ang buffer na naghihintay nito. | Error sa Engine. |
| -16 | gw2ret_fileRejected | Matagumpay na na-Process ang file ngunit hindi pinayagan ng setting ng policy. Tingnan ang analysis o ang GW2FileErrorMsg API call. | Naproseso ang file ngunit itinapon. |
| -17 | gw2ret_unableToWriteExportTextDump | Hindi maisulat ang output file ng text export. | Error sa Engine. |
| -18 | gw2ret_unableToWriteAnalysisReport | Hindi maisulat ang output file ng ulat ng analysis. | Error sa Engine. |
| -19 | gw2ret_inputTooLarge | Ang laki ng input file ay lampas sa limitasyong 2GiB. | Hindi wastong File. |
| -20 | gw2ret_inputZeroBytes | Ang laki ng input file ay 0 bytes. | Hindi wastong File. |
Malinis na nakilala
| Value | Pangalan ng system |
|---|---|
| 1 | gw2ret_ok_withcleaning |
| 0 | gw2ret_ok |
CorruptedRecognised
| Value | Pangalan ng system |
|---|---|
| -2 | gw2ret_unexpectedEndOfFile |
| -16 | gw2ret_fileRejected |
Hindi nakilalang file
| Value | Pangalan ng system |
|---|---|
| -7 | gw2ret_fileTypeUnknown |
Error sa Engine
| Value | Pangalan ng system |
|---|---|
| -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 |
Hindi wastong file
| Value | Pangalan ng system |
|---|---|
| -19 | gw2ret_inputTooLarge |
| -20 | gw2ret_inputZeroBytes |
Ipinapalagay ng bawat isa sa mga function na inilalarawan sa mga function ng API na isa sa mga halagang ito ang ibinabalik maliban kung iba ang nakasaad sa detalyadong paglalarawan.