使用功能文档

函数的文档分为几个部分：

概述

描述函数的用途。此部分还将显示有关该功能是否已折旧或未来版本可能不可用的信息。

句法

从相应的源标头显示函数声明。它是函数签名的快速参考。

参数

解释每个参数，参数是输入还是输出，以及其他重要注意事项。

返回值

本节介绍函数调用的结果，包括如何检测错误以及可用的其他信息。 （例如，如果 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 变体的字符串函数，这将列出这两个函数的实际导出名称。这通常只是带有 W 或 A 后缀的函数名称（分别）。