使用功能文件

函式的文件分為幾個部分:

概述

描述函式的用途。此部分還將顯示有關該功能是否已折舊或未來版本可能不可用的資訊。

句法

從相應的源標頭顯示函式宣告。它是函式簽名的快速參考。

引數

解釋每個引數,引數是輸入還是輸出,以及其他重要注意事項。

返回值

本節介紹函式呼叫的結果,包括如何檢測錯誤以及可用的其他資訊。 (例如,如果 GetLastError 將提供其他錯誤處理資訊,本節將明確說明。)

備註

涵蓋使用該功能所需的任何其他資訊,例如有關支援功能,獲取適當控制代碼和資源處置的資訊。

例子

如果此部分可用,則它具有適當使用該函式作為實現起點的示例。

要求

提供有關呼叫該函式的先決條件的重要資訊。這些資訊包括:

  • 最低支援的客戶端/伺服器作業系統的第一個版本(由 Microsoft 支援)以提供該功能。
    (請注意,這個欄位是眾所周知的誤導。通常,作業系統的早期版本支援函式,但此欄位僅顯示 Microsoft 當前支援的最早版本。例如,自 Windows 1.0 以來,支援 CreateWindow 功能,但文件僅顯示自 Windows 2000 以來它一直受支援 .MSDN 文件的線上版本並未指明任何內容在 2000 之前的 Windows 版本中支援函式,即使很多版本都支援。對於舊版開發,你需要查閱舊版本的 SDK 文件,例如可能已在 MSDN CD-ROM 上提供。或者,只需檢視標頭檔案。)
  • 標題包含函式宣告的 #include 的 SDK 標頭。如果函式在標題中不可用,則會顯示有關呼叫該函式的過程的資訊(通常呼叫 GetProcAddress 來進行執行時動態連結)。
  • 要傳遞給連結器以解析匯出函式的庫檔案。
  • DLL 包含匯出函式的檔案(隨作業系統提供)。
  • 客戶端/伺服器支援結束最後一個版本的 Windows 正式支援 API。
  • Unicode 和 ANSI 名稱對於同時具有 Unicode 和 ANSI 變體的字串函式,這將列出這兩個函式的實際匯出名稱。這通常只是帶有 WA 字尾的函式名稱(分別)。