Win32 API
Verwenden der MSDN-Dokumentation

Einführung

Bemerkungen

Arten der Dokumentation verfügbar

Die MSDN-Bibliothek enthält verschiedene Dokumentationsarten, die zur Implementierung von Features verwendet werden können.

• Diese Themenbereiche Übersichten sind breit Überblick über Themen soll ein allgemeines Verständnis einer API zur Verfügung zu stellen. Diese Übersichten enthalten häufig auch Best Practices und Implementierungsstrategien.
• Beispiele demonstrieren die Verwendung bestimmter APIs. Diese sind im Allgemeinen stark vereinfacht, führen keine Fehlerprüfung durch und verwenden normalerweise keine Frameworks wie MFC oder ATL. Sie bieten einen Ausgangspunkt für die Verwendung von Funktionen.
• Referenz Details aller Elemente der einzelnen API. Dies umfasst Konstanten / Enumerationen, Schnittstellen, Funktionen und Klassen.

Hinweis: Viele Microsoft-Mitarbeiter unterhalten auch Blogs, beispielsweise The Old New Thing von Raymond Chen, mit dem die Dokumentation ergänzt werden kann. Diese Blogs ersetzen jedoch nicht die Dokumentation.

Dokumentation für ein Feature suchen

Die Suche nach einer Dokumentation ist oft so einfach wie eine Suche mit einer guten Suchmaschine. Wenn dies fehlschlägt oder wenn Sie sich bezüglich bestimmter Begriffe nicht sicher sind, kann der Windows API-Index dazu beitragen, bestimmte Features zu finden. Die Dokumentation zu Methoden, Schnittstellen, Aufzählungen und Konstanten kann normalerweise durch Suchen nach dem Namen mithilfe einer Suchmaschine gefunden werden. Darüber hinaus bietet das Windows Dev Center einen wertvollen Ausgangspunkt.

Funktionsdokumentation verwenden

Die Dokumentation zu einer Funktion ist in mehrere Abschnitte unterteilt:

Überblick

Beschreibt, wofür die Funktion verwendet wird. Dieser Abschnitt enthält auch Informationen darüber, ob die Funktion abgeschrieben wird oder in zukünftigen Versionen nicht verfügbar ist.

Syntax

Zeigt die Deklaration der Funktion aus dem entsprechenden Quellheader an. Es ist ein kurzer Hinweis auf die Signatur der Funktion.

Parameter

Erläutert jeden Parameter, ob der Parameter Eingabe oder Ausgabe ist, und andere wichtige Überlegungen.

Rückgabewert

In diesem Abschnitt wird das Ergebnis des Funktionsaufrufs erläutert. Außerdem wird erläutert, wie Fehler erkannt werden und welche zusätzlichen Informationen verfügbar sind. (In diesem Abschnitt wird beispielsweise explizit angegeben, ob GetLastError zusätzliche Informationen zur Fehlerbehandlung bereitstellt.)

Bemerkungen

Umfasst alle zusätzlichen Informationen, die zur Verwendung der Funktion erforderlich sind, z. B. Informationen zu unterstützenden Funktionen, zum Erhalten geeigneter Handles und zum Entsorgen von Ressourcen.

Beispiele

Wenn dieser Abschnitt verfügbar ist, gibt es ein Beispiel für die geeignete Verwendung der Funktion als Ausgangspunkt für die Implementierung.

Bedarf

Gibt wichtige Informationen zu den Voraussetzungen für den Aufruf der Funktion. Diese Informationen beinhalten:

• Minimaler unterstützter Client / Server Erste Version des Betriebssystems (unterstützt von Microsoft), die die Funktion bereitstellt.
  _{(Beachten Sie, dass dieses Feld bekanntermaßen irreführend ist. Häufig werden Funktionen in einer früheren Version des Betriebssystems unterstützt, dieses Feld zeigt jedoch nur die früheste Version, die derzeit von Microsoft unterstützt wird . Beispielsweise wurde die Funktion CreateWindow seit Windows 1.0 unterstützt Die Dokumentation zeigt jedoch nur, dass sie seit Windows 2000 unterstützt wird. Die Online-Version der MSDN-Dokumentation gibt nicht an, dass eine Funktion in einer Windows-Version vor 2000 unterstützt wurde, auch wenn viele vorhanden waren Sie müssen eine ältere Version der SDK-Dokumentation aufrufen, die möglicherweise auf einer MSDN-CD-ROM enthalten ist. Oder schauen Sie sich einfach die Header-Dateien an.)}
• Header Der SDK-Header für #include , der die Funktionsdeklaration enthält. Wenn die Funktion in einem Header nicht verfügbar ist, werden Informationen über die Prozedur zum Aufrufen der Funktion GetProcAddress (normalerweise Aufruf von GetProcAddress , um dynamische Laufzeitverknüpfungen GetProcAddress ).
• Bibliothek Die Bibliotheksdatei, die an den Linker übergeben wird, um die exportierten Funktionen aufzulösen.
• DLL Die Datei (im Lieferumfang des Betriebssystems enthalten), die die exportierte Funktion enthält.
• Ende der Client- / Serverunterstützung Die letzte Version von Windows, die die API offiziell unterstützt.
• Unicode- und ANSI-Namen Bei String-Funktionen, die sowohl Unicode- als auch ANSI-Varianten enthalten, werden die tatsächlich exportierten Namen für die beiden Funktionen aufgelistet. Dies ist normalerweise nur der Funktionsname mit einem W oder A Suffix (jeweils).