API अवलोकन
प्रकार
API क्लाइंट्स द्वारा कुछ API फ़ंक्शनों के लिए आर्ग्युमेंट प्रकारों के रूप में उपयोग हेतु तीन enumerations उपलब्ध कराती है। अपनी source file में header file glasswall.core2.api.h शामिल करें और API फ़ंक्शनों को कॉल करते समय enumerators का उपयोग करें।
Policy_format
Enumeration Policy_format का उपयोग policies file के format को निर्दिष्ट करने के लिए किया जाता है। निम्नलिखित enumerator उपलब्ध है:
PF_XML
Analysis_format
Enumeration Analysis_format का उपयोग analysis file के format को निर्दिष्ट करने के लिए किया जाता है। निम्नलिखित enumerator उपलब्ध है:
AF_XML
ft_t
Enumeration ft_t का उपयोग किसी file के file type (file format) को इंगित करने के लिए किया जाता है। इन्हें उपयोग करने के लिए अपनी source code files में header file filetype.h शामिल करें।
रिटर्न प्रकार
Glasswall API में अधिकांश फ़ंक्शन एक ऐसा मान लौटाते हैं जो सफलता या विफलता को दर्शाता है। मान और उनका अर्थ नीचे सूचीबद्ध हैं।
| मान | सिस्टम नाम | अर्थ | प्रोसेसिंग प्रतिक्रिया |
|---|---|---|---|
| 1 | gw2ret_ok_withcleaning | फ़ाइल सफलतापूर्वक प्रोसेस की गई। Sanitisations या remedies, या दोनों, लागू किए गए हैं। | Managed फ़ाइल तैयार की गई |
| 0 | gw2ret_ok | फ़ाइल सफलतापूर्वक प्रोसेस की गई। कोई sanitisations या remedies लागू नहीं किए गए हैं। | Managed फ़ाइल तैयार की गई |
| -1 | gw2ret_generalfail | प्रोसेसिंग के दौरान सामान्य विफलता, सिस्टम या संसाधन संबंधी समस्या | Engine त्रुटि। |
| -2 | gw2ret_unexpectedEndOfFile | फ़ाइल का अंत, या फ़ाइल-अंत मार्कर, अप्रत्याशित रूप से पाया गया। | फ़ाइल प्रोसेस की गई लेकिन त्याग दी गई। |
| -3 | gw2ret_licenseExpired | License फ़ाइल की अवधि समाप्त हो गई है, डेटा गलत है या अनुपस्थित है। | Engine त्रुटि। |
| -4 | gw2ret_incorrectSessionSetup | policy फ़ाइल की कोई सेटिंग मान्य मान नहीं है (XSD देखें)। या कोई registration असंगत है। उदाहरण के लिए, input file और input buffer दोनों को register करने का प्रयास, जबकि केवल एक source हो सकता है। | Engine त्रुटि। |
| -5 | gw2ret_incorrectPolicySetup | Policy फ़ाइल लोड नहीं की जा सकी या सामग्री में त्रुटि है। | Engine त्रुटि। |
| -6 | gw2ret_unableToLoadInput | इनपुट फ़ाइल लोड नहीं की जा सकी या उसे शामिल करने वाले बफ़र तक पहुँचा नहीं जा सका। | Engine त्रुटि। |
| -7 | gw2ret_fileTypeUnknown | फ़ाइल प्रकार निर्धारित नहीं किया जा सका | अपरिचित फ़ाइल। |
| -8 | gw2ret_unknownSessionID | API call में उपयोग किया गया Session ID सक्रिय Sessions की सूची में नहीं मिला। Session या तो बनाया नहीं गया था या पहले ही हटाया जा चुका था। | Engine त्रुटि। |
| -9 | gw2ret_argumentError | API call में दिए गए arguments में से एक अमान्य था। | Engine त्रुटि। |
| -10 | gw2ret_unableToLoadImport | इम्पोर्ट डेटा फ़ाइल लोड नहीं की जा सकी या उसे शामिल करने वाले बफ़र तक पहुँचा नहीं जा सका। | Engine त्रुटि। |
| -11 | gw2ret_cameraDidNotInitialise | एक camera plugin initialize होने में विफल रहा। | Engine त्रुटि। |
| -12 | gw2ret_noCamerasConnected | कोई भी camera plugins लोड नहीं किए गए हैं। | Engine त्रुटि। |
| -13 | gw2ret_engineeringOnlyGoesToFile | अप्रयुक्त। भविष्य में उपयोग के लिए आरक्षित। | Engine त्रुटि। |
| -14 | gw2ret_unableToWriteOutput | आउटपुट फ़ाइल या उसे अपेक्षित करने वाले बफ़र में लिखने में असमर्थ। | Engine त्रुटि। |
| -15 | gw2ret_unableToWriteExport | एक्सपोर्ट डेटा फ़ाइल या उसे अपेक्षित करने वाले बफ़र में लिखने में असमर्थ। | Engine त्रुटि। |
| -16 | gw2ret_fileRejected | फ़ाइल सफलतापूर्वक Process की गई थी, लेकिन policy सेटिंग द्वारा अस्वीकृत कर दी गई। analysis या GW2FileErrorMsg API call देखें। | फ़ाइल प्रोसेस की गई लेकिन त्याग दी गई। |
| -17 | gw2ret_unableToWriteExportTextDump | टेक्स्ट एक्सपोर्ट आउटपुट फ़ाइल में लिखने में असमर्थ। | Engine त्रुटि। |
| -18 | gw2ret_unableToWriteAnalysisReport | analysis report आउटपुट फ़ाइल में लिखने में असमर्थ। | Engine त्रुटि। |
| -19 | gw2ret_inputTooLarge | इनपुट फ़ाइल का आकार 2GiB सीमा से अधिक है। | अमान्य फ़ाइल। |
| -20 | gw2ret_inputZeroBytes | इनपुट फ़ाइल का आकार 0 बाइट है। | अमान्य फ़ाइल। |
स्वच्छ recognised
| मान | सिस्टम नाम |
|---|---|
| 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 functions में वर्णित प्रत्येक function यह मानता है कि, जब तक विस्तृत विवरण में अन्यथा न कहा गया हो, इनमें से कोई एक मान लौटाया जाता है।