Win32 API
MSDN प्रलेखन का उपयोग
खोज…
परिचय
विंडोज एपीआई विशाल है, और इसमें बहुत सारी विशेषताएं हैं। एपीआई का आकार ऐसा है कि कोई भी इसे नहीं जान सकता है। जबकि StackOverflow जैसे कई संसाधन हैं, आधिकारिक दस्तावेज के लिए कोई विकल्प नहीं है।
टिप्पणियों
प्रलेखन के उदाहरण:
उपलब्ध प्रलेखन के प्रकार
MSDN लाइब्रेरी में कई अलग-अलग प्रकार के दस्तावेज़ होते हैं जिनका उपयोग सुविधाओं को लागू करने के लिए किया जा सकता है।
- टॉपिक साक्षात्कार ये एक एपीआई की एक सामान्य समझ प्रदान करने के उद्देश्य से विषयों के व्यापक साक्षात्कार हैं। ये ओवरव्यू भी अक्सर सर्वोत्तम प्रथाओं, और कार्यान्वयन रणनीतियों को रेखांकित करते हैं।
- नमूने विशेष APIs के उपयोग को प्रदर्शित करते हैं। ये आम तौर पर अत्यधिक सरलीकृत होते हैं, आवश्यक रूप से त्रुटि जाँच नहीं करते हैं, और आमतौर पर MFC या ATL जैसे फ्रेमवर्क का उपयोग नहीं करते हैं। वे सुविधाओं का उपयोग करने के लिए एक प्रारंभिक बिंदु प्रदान करते हैं।
- संदर्भ प्रत्येक एपीआई के तत्वों के सभी विवरण। इसमें स्थिरांक / गणना, इंटरफेस, फ़ंक्शन और कक्षाएं शामिल हैं।
नोट: कई Microsoft कर्मचारी भी ब्लॉग्स का रखरखाव करते हैं, जैसे रेमंड चेन की द ओल्ड न्यू थिंग जो दस्तावेज़ीकरण को पूरक कर सकता है, लेकिन ये ब्लॉग दस्तावेज़ीकरण का विकल्प नहीं हैं।
फ़ीचर के लिए दस्तावेज़ीकरण ढूँढना
एक सुविधा के लिए प्रलेखन खोजना अक्सर एक अच्छा खोज इंजन का उपयोग करके खोज के रूप में सरल होता है। यदि वह विफल रहता है, या यदि विशिष्ट शब्दों के बारे में अनिश्चित है, तो Windows API इंडेक्स विशिष्ट सुविधाओं का पता लगाने में मदद कर सकता है। आमतौर पर खोज इंजन का उपयोग करके नाम खोजने के तरीकों, इंटरफेस, गणना और स्थिरांक के लिए प्रलेखन पाया जा सकता है। इसके अतिरिक्त, विंडोज देव केंद्र एक मूल्यवान प्रारंभिक बिंदु प्रदान कर सकता है।
समारोह प्रलेखन का उपयोग करना
एक समारोह के लिए प्रलेखन कई वर्गों में टूट गया है:
अवलोकन
वर्णन करता है कि फ़ंक्शन किसके लिए उपयोग किया जाता है। यह अनुभाग इस बारे में भी जानकारी दिखाएगा कि क्या फ़ंक्शन का मूल्यह्रास किया गया है, या भविष्य के संस्करणों में अनुपलब्ध हो सकता है।
वाक्य - विन्यास
उपयुक्त स्रोत हेडर से फ़ंक्शन की घोषणा दिखाता है। यह फ़ंक्शन के हस्ताक्षर का एक त्वरित संदर्भ है।
पैरामीटर
प्रत्येक पैरामीटर की व्याख्या करता है, चाहे पैरामीटर इनपुट या आउटपुट, और अन्य महत्वपूर्ण विचार हो।
प्रतिलाभ की मात्रा
यह अनुभाग फ़ंक्शन कॉल के परिणाम की व्याख्या करता है, जिसमें त्रुटियों का पता लगाने का तरीका, और क्या अतिरिक्त जानकारी उपलब्ध है। (उदाहरण के लिए, यह खंड स्पष्ट रूप से GetLastError कि GetLastError अतिरिक्त त्रुटि हैंडलिंग जानकारी प्रदान करेगा।)
टिप्पणियों
फ़ंक्शन का उपयोग करने के लिए आवश्यक किसी भी अतिरिक्त जानकारी को शामिल करता है, जैसे, सहायक कार्यों के बारे में जानकारी, उपयुक्त हैंडल प्राप्त करना, और संसाधनों का निपटान।
उदाहरण
यदि यह खंड उपलब्ध है, तो इसे लागू करने के लिए एक प्रारंभिक बिंदु के रूप में उपयोग करने के लिए फ़ंक्शन के उपयुक्त उपयोग का एक उदाहरण है।
आवश्यकताएँ
फ़ंक्शन को कॉल करने के लिए आवश्यक शर्तें के बारे में महत्वपूर्ण जानकारी देता है। इस जानकारी में शामिल हैं:
- फ़ंक्शन प्रदान करने के लिए न्यूनतम समर्थित क्लाइंट / सर्वर ऑपरेटिंग सिस्टम (Microsoft द्वारा समर्थित) का पहला संस्करण।
(ध्यान दें कि यह फ़ील्ड बहुत ही भ्रामक है। अक्सर, ऑपरेटिंग सिस्टम के पुराने संस्करण में फ़ंक्शंस का समर्थन किया जाता है, लेकिन यह फ़ील्ड केवल उस शुरुआती संस्करण को दिखाती है जो वर्तमान में Microsoft द्वारा समर्थित है । उदाहरण के लिए,CreateWindowफ़ंक्शन को विंडोज 1.0 के साथ समर्थन किया गया है। , लेकिन प्रलेखन केवल यह दर्शाता है कि यह विंडोज 2000 के बाद से समर्थित है। MSDN प्रलेखन के ऑनलाइन संस्करण से यह संकेत नहीं मिलता है कि किसी भी फ़ंक्शन को 2000 से पहले विंडोज के एक संस्करण में समर्थित किया गया था, भले ही कई थे। विरासत विकास के लिए, आप। SDK प्रलेखन के पुराने संस्करण से परामर्श करने की आवश्यकता है, जैसे कि MSDN CD-ROM पर भेज दिया गया हो सकता है। या, शीर्ष लेख फ़ाइलों में देखें।) - करने के लिए हैडर एसडीके हैडर
#includeहै कि समारोह घोषणा है। यदि फ़ंक्शन हेडर में उपलब्ध नहीं है, तो यह फ़ंक्शन को कॉल करने की प्रक्रिया के बारे में जानकारी दिखाएगा (आमतौर पर रन-टाइम डायनेमिक लिंकिंग करने के लिएGetProcAddressको कॉल करना)। - लाइब्रेरी निर्यात किए गए कार्यों को हल करने के लिए लिंकर को पास करने के लिए लाइब्रेरी फ़ाइल।
- DLL फ़ाइल (ऑपरेटिंग सिस्टम के साथ भेज दिया गया) जिसमें निर्यातित फ़ंक्शन होता है।
- क्लाइंट / सर्वर समर्थन का अंत आधिकारिक तौर पर एपीआई का समर्थन करने के लिए विंडोज का अंतिम संस्करण है।
- यूनिकोड और एएनएसआई नाम स्ट्रिंग फ़ंक्शंस के लिए जिसमें यूनिकोड और एएनएसआई दोनों प्रकार हैं, यह दो कार्यों के लिए वास्तविक निर्यात किए गए नामों को सूचीबद्ध करता है। यह आमतौर पर केवल
WयाAप्रत्यय (क्रमशः) के साथ फ़ंक्शन नाम है।