Win32 API
Utilizzando la documentazione MSDN

introduzione

Osservazioni

Tipi di documentazione disponibili

La libreria MSDN contiene diversi tipi di documentazione che possono essere utilizzati per implementare le funzionalità.

• Panoramica dei topic Si tratta di panoramiche generali di argomenti intesi a fornire una comprensione generale di un'API. Queste panoramiche spesso delineano anche le migliori pratiche e le strategie di implementazione.
• Esempi Dimostrare l'uso di particolari API. Questi sono generalmente molto semplificati, non eseguono necessariamente il controllo degli errori e in genere non utilizzano framework come MFC o ATL. Forniscono un punto di partenza per l'utilizzo delle funzionalità.
• Riferimento Dettagli tutti gli elementi di ciascuna API. Questo include costanti / enumerazioni, interfacce, funzioni e classi.

Nota: molti dipendenti Microsoft gestiscono anche blog, come The Old New Thing di Raymond Chen, che possono integrare la documentazione, ma questi blog non sostituiscono la documentazione.

Trovare la documentazione per una caratteristica

Trovare documentazione per una funzionalità è spesso semplice come una ricerca utilizzando un buon motore di ricerca. In caso di esito negativo o se non si è sicuri dei termini specifici, l' indice API di Windows può aiutare a individuare funzionalità specifiche. La documentazione per i metodi, le interfacce, le enumerazioni e le costanti può essere trovata solitamente cercando il nome usando un motore di ricerca. Inoltre, Windows Dev Center può fornire un prezioso punto di partenza.

Utilizzo della documentazione di funzione

La documentazione di una funzione è suddivisa in diverse sezioni:

Panoramica

Descrive a cosa serve la funzione. Questa sezione mostrerà anche informazioni sull'eventuale deprezzamento della funzione, o potrebbe non essere disponibile nelle versioni future.

Sintassi

Mostra la dichiarazione della funzione dall'intestazione della fonte appropriata. È un rapido riferimento alla firma della funzione.

parametri

Spiega ciascuno dei parametri, indipendentemente dal fatto che il parametro sia input o output e altre considerazioni importanti.

Valore di ritorno

Questa sezione spiega il risultato della chiamata di funzione, incluso come rilevare gli errori e quali informazioni aggiuntive sono disponibili. (Ad esempio, questa sezione indicherà esplicitamente se GetLastError fornirà ulteriori informazioni sulla gestione degli errori.)

Osservazioni

Copre tutte le informazioni aggiuntive richieste per utilizzare la funzione, ad esempio informazioni sulle funzioni di supporto, l'ottenimento di handle appropriati e lo smaltimento delle risorse.

Esempi

Se questa sezione è disponibile, contiene un esempio dell'uso appropriato della funzione da utilizzare come punto di partenza per l'implementazione.

Requisiti

Fornisce informazioni importanti sui prerequisiti per chiamare la funzione. Queste informazioni includono:

• Minimo Client / Server supportati Prima versione del sistema operativo (supportata da Microsoft) per fornire la funzione.
  _{(Si noti che questo campo è notoriamente fuorviante.) Spesso le funzioni sono supportate in una versione precedente del sistema operativo, ma questo campo mostra solo la versione più recente attualmente supportata da Microsoft , ad esempio, la funzione CreateWindow è supportata da Windows 1.0 , ma la documentazione mostra solo che è stato supportato da Windows 2000. La versione online della documentazione MSDN non indica che nessuna funzione era supportata in una versione di Windows precedente al 2000, anche se molti lo erano. Per lo sviluppo legacy, si è necessario consultare una versione precedente della documentazione dell'SDK, come potrebbe essere stata spedita su un CD-ROM MSDN. Oppure, basta guardare nei file dell'intestazione.)}
• Intestazione L'intestazione dell'SDK per #include che contiene la dichiarazione della funzione. Se la funzione non è disponibile in un'intestazione, questo mostrerà le informazioni sulla procedura per chiamare la funzione (in genere chiamando GetProcAddress per eseguire il collegamento dinamico di runtime).
• Libreria Il file della libreria da passare al linker per risolvere le funzioni esportate.
• DLL Il file (fornito con il sistema operativo) che contiene la funzione esportata.
• Fine del supporto client / server L'ultima versione di Windows supporta ufficialmente l'API.
• Nomi Unicode e ANSI Per le funzioni stringa con varianti Unicode e ANSI, questo elenca i nomi effettivi esportati per le due funzioni. Solitamente questo è solo il nome della funzione con un suffisso W o A (rispettivamente).