Win32 API
Använda MSDN-dokumentation

Introduktion

Anmärkningar

Dokumentationstyper tillgängliga

MSDN-biblioteket innehåller flera olika typer av dokumentation som kan användas för att implementera funktioner.

• Ämneöversikter Dessa är breda översikter över ämnen som är avsedda att ge en allmän förståelse av ett API. Dessa översikter beskriver ofta bästa praxis och implementeringsstrategier.
• Prover visar användningen av särskilda API: er. Dessa är generellt mycket förenklade, gör inte nödvändigtvis felkontroll och använder vanligtvis inte ramar som MFC eller ATL. De utgör en utgångspunkt för att använda funktioner.
• Referens Mer information om alla element i varje API. Detta inkluderar konstanter / uppräkningar, gränssnitt, funktioner och klasser.

Obs! Många Microsoft-anställda har också bloggar, till exempel Raymond Chens The Old New Thing som kan komplettera dokumentationen, men dessa bloggar ersätter inte dokumentationen.

Hitta dokumentation för en funktion

Att hitta dokumentation för en funktion är ofta lika enkelt som en sökning med en bra sökmotor. Om detta misslyckas, eller om du är osäker på specifika termer, kan Windows API-index hjälpa till att hitta specifika funktioner. Dokumentation för metoder, gränssnitt, uppräkningar och konstanter kan vanligtvis hittas genom att söka efter namnet med hjälp av en sökmotor. Dessutom kan Windows Dev Center ge en värdefull utgångspunkt.

Använda funktionsdokumentation

Dokumentationen för en funktion är uppdelad i flera avsnitt:

Översikt

Beskriver vad funktionen används för. Det här avsnittet visar också information om funktionen skrivs av eller om den inte är tillgänglig i framtida versioner.

Syntax

Visar deklarationen för funktionen från lämplig källhuvud. Det är en snabb referens till funktionens signatur.

parametrar

Förklarar var och en av parametrarna, oavsett om parametern är input eller output, och andra viktiga överväganden.

Returvärde

Det här avsnittet förklarar resultatet av funktionssamtalet, inklusive hur man upptäcker fel och vilken ytterligare information som finns tillgänglig. (Till exempel kommer det här avsnittet att GetLastError uttryckligen om GetLastError kommer att ge ytterligare information om felhantering.)

Anmärkningar

Täcker all ytterligare information som krävs för att använda funktionen, till exempel information om stödfunktioner, erhålla lämpliga handtag och bortskaffande av resurser.

exempel

Om detta avsnitt är tillgängligt har det ett exempel på lämplig användning av funktionen som ska användas som utgångspunkt för implementering.

Krav

Ger viktig information om förutsättningar för att ringa funktionen. Denna information inkluderar:

• Minsta stödda klient / server Första versionen av operativsystemet (stöds av Microsoft) för att tillhandahålla funktionen.
  _{(Observera att detta fält är notoriskt vilseledande. Funktioner stöds ofta i en tidigare version av operativsystemet, men det här fältet visar bara den tidigaste versionen som för närvarande stöds av Microsoft . Exempelvis har CreateWindow funktionen stöds sedan Windows 1.0 , men dokumentationen visar bara att den har stöds sedan Windows 2000. Online-versionen av MSDN-dokumentationen indikerar inte att någon funktion stöds i en version av Windows före 2000, även om många var det. måste konsultera en äldre version av SDK-dokumentationen, som kan ha skickats på en MSDN-CD-ROM. Eller titta bara i rubrikfilerna.)}
• Header SDK-huvudet till #include som innehåller funktionsdeklarationen. Om funktionen inte är tillgänglig i en rubrik kommer den att visa information om proceduren för att ringa funktionen (vanligtvis ringer GetProcAddress att göra dynamisk länkning av körtid).
• Bibliotek Biblioteksfilen som ska skickas till länken för att lösa de exporterade funktionerna.
• DLL Filen (som levereras med operativsystemet) som innehåller den exporterade funktionen.
• Slut på klient / server support Den sista versionen av Windows som officiellt stöder API.
• Unicode- och ANSI-namn För strängfunktioner som har både Unicode- och ANSI-varianter listar detta de faktiska exporterade namnen för de två funktionerna. Detta är vanligtvis bara funktionsnamnet med ett W eller A suffix (respektive).