Win32 API
Utilisation de la documentation MSDN

Introduction

Remarques

Types de documentation disponibles

La bibliothèque MSDN contient plusieurs types de documentation pouvant être utilisés pour implémenter des fonctionnalités.

• Aperçus de sujet Il s'agit de grands aperçus de sujets destinés à fournir une compréhension générale d'une API. Ces aperçus décrivent également souvent les meilleures pratiques et les stratégies de mise en œuvre.
• Exemples Démontrer l'utilisation de certaines API. Celles-ci sont généralement très simplifiées, ne vérifient pas nécessairement les erreurs et n'utilisent généralement pas de frameworks tels que MFC ou ATL. Ils fournissent un point de départ pour l'utilisation des fonctionnalités.
• Référence Détaille tous les éléments de chaque API. Cela inclut les constantes / énumérations, les interfaces, les fonctions et les classes.

Remarque: de nombreux employés de Microsoft gèrent également des blogs, comme The Old New Thing de Raymond Chen, qui peuvent compléter la documentation, mais ces blogs ne remplacent pas la documentation.

Recherche de documentation pour une fonctionnalité

Trouver de la documentation pour une fonctionnalité est souvent aussi simple qu'une recherche utilisant un bon moteur de recherche. Si cela échoue ou si vous n'êtes pas sûr des termes spécifiques, l' index de l'API Windows peut vous aider à localiser des fonctionnalités spécifiques. La documentation des méthodes, interfaces, énumérations et constantes peut généralement être trouvée en recherchant le nom à l'aide d'un moteur de recherche. De plus, le centre de développement Windows peut constituer un point de départ précieux.

Utilisation de la documentation de fonction

La documentation d'une fonction est divisée en plusieurs sections:

Vue d'ensemble

Décrit à quoi sert la fonction. Cette section affiche également des informations indiquant si la fonction est dépréciée ou peut ne pas être disponible dans les futures versions.

Syntaxe

Affiche la déclaration de la fonction à partir de l'en-tête source approprié. C'est une référence rapide à la signature de la fonction.

Paramètres

Explique chacun des paramètres, que le paramètre soit en entrée ou en sortie, et d'autres considérations importantes.

Valeur de retour

Cette section explique le résultat de l'appel de la fonction, y compris comment détecter les erreurs et quelles informations supplémentaires sont disponibles. (Par exemple, cette section indiquera explicitement si GetLastError fournira des informations supplémentaires sur le traitement des erreurs.)

Remarques

Couvre toutes les informations supplémentaires requises pour utiliser la fonction, telles que les informations sur les fonctions de prise en charge, l'obtention des descripteurs appropriés et l'élimination des ressources.

Exemples

Si cette section est disponible, elle contient un exemple d'utilisation appropriée de la fonction à utiliser comme point de départ pour la mise en œuvre.

Exigences

Donne des informations importantes sur les conditions préalables à l'appel de la fonction. Cette information comprend:

• Minimum Client / Serveur pris en charge Première version du système d'exploitation (prise en charge par Microsoft) pour fournir la fonction.
  _{(Notez que ce champ est notoirement trompeur. Souvent, les fonctions sont prises en charge dans une version antérieure du système d'exploitation, mais ce champ affiche uniquement la version la plus ancienne actuellement prise en charge par Microsoft . Par exemple, la fonction CreateWindow est prise en charge depuis Windows 1.0 , mais la documentation montre seulement qu'il a été pris} en _{charge depuis Windows 2000. la version} en _{ligne de la documentation MSDN ne signifie pas que toute fonction a été prise en charge dans une version de Windows avant 2000, même si beaucoup étaient. pour} le _{développement de} l' _{héritage, vous allez besoin de consulter une ancienne version de la documentation du SDK, telle que celle qui peut avoir été livrée sur un CD-ROM MSDN, ou simplement regarder dans les fichiers d'en-tête.}
• En-tête En-tête SDK à #include contenant la déclaration de fonction. Si la fonction n'est pas disponible dans un en-tête, cela affichera des informations sur la procédure à GetProcAddress pour appeler la fonction (en général, l'appel à GetProcAddress pour GetProcAddress une liaison dynamique au moment de l'exécution).
• Bibliothèque Le fichier de bibliothèque à transmettre à l'éditeur de liens pour résoudre les fonctions exportées.
• DLL Le fichier (fourni avec le système d'exploitation) contenant la fonction exportée.
• Prise en charge de la fin du client / du serveur La dernière version de Windows pour supporter officiellement l'API.
• Noms Unicode et ANSI Pour les fonctions de chaîne ayant des variantes Unicode et ANSI, cette liste répertorie les noms exportés réels pour les deux fonctions. C'est généralement le nom de la fonction avec un suffixe W ou A (respectivement).