Win32 API
Gebruik MSDN-documentatie

Invoering

Opmerkingen

Soorten documentatie beschikbaar

De MSDN-bibliotheek bevat verschillende soorten documentatie die kunnen worden gebruikt voor het implementeren van functies.

• Onderwerpoverzichten Dit zijn brede overzichten van onderwerpen die bedoeld zijn om een algemeen begrip van een API te geven. Deze overzichten geven ook vaak best practices en implementatiestrategieën weer.
• Voorbeelden Toon het gebruik van bepaalde API's aan. Deze zijn over het algemeen sterk vereenvoudigd, hoeven niet noodzakelijkerwijs fouten te controleren en gebruiken meestal geen frameworks zoals MFC of ATL. Ze bieden een startpunt voor het gebruik van functies.
• Referentie Details alle elementen van elke API. Dit omvat constanten / opsommingen, interfaces, functies en klassen.

Opmerking: Veel Microsoft-medewerkers houden ook blogs bij, zoals The Old New Thing van Raymond Chen die de documentatie kunnen aanvullen, maar deze blogs zijn geen vervanging voor de documentatie.

Documentatie zoeken voor een functie

Het vinden van documentatie voor een functie is vaak net zo eenvoudig als een zoekopdracht met een goede zoekmachine. Als dat niet lukt, of als u niet zeker bent over specifieke voorwaarden, kan de Windows API-index helpen bij het vinden van specifieke functies. Documentatie voor methoden, interfaces, opsommingen en constanten kan meestal worden gevonden door met een zoekmachine naar de naam te zoeken. Bovendien kan het Windows Dev Center een waardevol startpunt bieden.

Functiedocumentatie gebruiken

De documentatie voor een functie is onderverdeeld in verschillende secties:

Overzicht

Beschrijft waarvoor de functie wordt gebruikt. In deze sectie wordt ook informatie weergegeven over of de functie wordt afgeschreven of mogelijk niet beschikbaar is in toekomstige versies.

Syntaxis

Toont de declaratie van de functie uit de juiste bronkop. Het is een snelle verwijzing naar de handtekening van de functie.

parameters

Beschrijft elk van de parameters, of de parameter invoer of uitvoer is, en andere belangrijke overwegingen.

Winstwaarde

In dit gedeelte wordt het resultaat van de functieaanroep uitgelegd, inclusief hoe u fouten kunt detecteren en welke aanvullende informatie beschikbaar is. (In deze sectie wordt bijvoorbeeld expliciet vermeld of GetLastError aanvullende informatie over GetLastError zal bieden.)

Opmerkingen

Bevat alle aanvullende informatie die nodig is om de functie te gebruiken, zoals informatie over ondersteunende functies, het verkrijgen van geschikte handvatten en het weggooien van middelen.

Voorbeelden

Als deze sectie beschikbaar is, bevat deze een voorbeeld van het juiste gebruik van de functie die moet worden gebruikt als startpunt voor implementatie.

Voorwaarden

Geeft belangrijke informatie over vereisten voor het aanroepen van de functie. Deze informatie omvat:

• Minimaal ondersteunde client / server Eerste versie van het besturingssysteem (ondersteund door Microsoft) om de functie te bieden.
  _{(Merk op dat dit veld notoir misleidend is. Vaak worden functies ondersteund in een eerdere versie van het besturingssysteem, maar dit veld toont alleen de vroegste versie die momenteel wordt ondersteund door Microsoft . De functie CreateWindow wordt bijvoorbeeld ondersteund sinds Windows 1.0 , maar de documentatie laat alleen zien dat het wordt ondersteund sinds Windows 2000. De online versie van de MSDN-documentatie geeft niet aan dat een functie in een versie van Windows vóór 2000 werd ondersteund, ook al waren dat er veel. moet u een oudere versie van de SDK-documentatie raadplegen, zoals die mogelijk op een MSDN-cd-rom is geleverd. Of kijk gewoon in de header-bestanden.)}
• Koptekst De SDK-koptekst voor #include die de functieverklaring bevat. Als de functie niet beschikbaar is in een koptekst, wordt hier informatie weergegeven over de procedure om de functie aan te roepen (meestal wordt GetProcAddress om runtime dynamische koppelingen te doen).
• Bibliotheek Het bibliotheekbestand dat aan de linker wordt doorgegeven om de geëxporteerde functies op te lossen.
• DLL Het bestand (zoals geleverd bij het besturingssysteem) dat de geëxporteerde functie bevat.
• Einde ondersteuning client / server De laatste versie van Windows die officieel de API ondersteunt.
• Unicode- en ANSI-namen Voor tekenreeksfuncties die zowel Unicode- als ANSI-varianten hebben, worden hier de daadwerkelijke geëxporteerde namen voor de twee functies vermeld. Dit is meestal alleen de functienaam met een W of A achtervoegsel (respectievelijk).