Win32 API
Использование документации MSDN

Вступление

замечания

Доступные типы документации

Библиотека MSDN содержит несколько различных типов документации, которые могут быть использованы для реализации функций.

• Обзор тем Это широкий обзор тем, предназначенных для общего понимания API. В этих обзорах также часто описываются передовые методы и стратегии реализации.
• Образцы демонстрируют использование определенных API. Они, как правило, очень упрощены, не обязательно выполняют проверку ошибок и, как правило, не используют фреймворки, такие как MFC или ATL. Они обеспечивают отправную точку для использования функций.
• Ссылка Подробности всех элементов каждого API. Сюда входят константы / перечисления, интерфейсы, функции и классы.

Примечание. Многие сотрудники Microsoft также поддерживают блоги, такие как « Новая новая вещь» Раймонда Чена, которые могут дополнять документацию, но эти блоги не заменяют документацию.

Поиск документации для функции

Поиск документации для функции часто бывает так же просто, как поиск с использованием хорошей поисковой системы. Если это не удается или если вы не уверены в конкретных условиях, индекс Windows API может помочь найти определенные функции. Документацию по методам, интерфейсам, перечислениям и константам обычно можно найти путем поиска имени с помощью поисковой системы. Кроме того, Центр Windows Dev может стать ценной отправной точкой.

Использование функциональной документации

Документация для функции разбита на несколько разделов:

обзор

Описывает, для чего используется функция. В этом разделе также будет показана информация о том, обесценена ли функция или может быть недоступна в будущих версиях.

Синтаксис

Показывает объявление функции из соответствующего заголовка источника. Это краткая ссылка на подпись функции.

параметры

Объясняет каждый из параметров, независимо от того, введен или нет параметр, и другие важные соображения.

Возвращаемое значение

В этом разделе объясняется результат вызова функции, в том числе, как выявлять ошибки и какая дополнительная информация доступна. (Например, этот раздел будет явно GetLastError если GetLastError предоставит дополнительную информацию об обработке ошибок.)

замечания

Охватывает любую дополнительную информацию, необходимую для использования функции, такую ​​как информация о вспомогательных функциях, получение соответствующих ручек и удаление ресурсов.

Примеры

Если этот раздел доступен, в нем есть пример соответствующего использования функции для использования в качестве отправной точки для реализации.

Требования

Предоставляет важную информацию о предварительных требованиях для вызова функции. Эта информация включает:

• Минимальный поддерживаемый клиент / сервер. Первая версия операционной системы (поддерживается Microsoft) для обеспечения этой функции.
  _{(Обратите внимание, что это поле, как правило, вводит в заблуждение. Часто функции поддерживаются в более ранней версии операционной системы, но в этом поле отображается только самая ранняя версия, которая в настоящее время поддерживается Microsoft . Например, функция CreateWindow поддерживается с Windows 1.0 , но в документации только показано, что она поддерживается с Windows 2000. Онлайн-версия документации MSDN не указывает, что любая функция поддерживалась в версии Windows до 2000 года, хотя многие из них были доступны. необходимо проконсультироваться с более старой версией документации SDK, например, возможно, она была отправлена ​​на компакт-диск MSDN или просто просмотрите файлы заголовков.)}
• Заголовок Заголовок SDK для #include , содержащий объявление функции. Если функция недоступна в заголовке, это покажет информацию о процедуре для вызова функции (обычно вызывающей GetProcAddress для выполнения динамической компоновки во время выполнения).
• Библиотека Файл библиотеки, который нужно передать в компоновщик для разрешения экспортированных функций.
• DLL Файл (поставляется вместе с операционной системой), который содержит экспортированную функцию.
• End of Client / Server Support Последняя версия Windows официально поддерживает API.
• Имена Unicode и ANSI Для строковых функций, которые имеют как Unicode, так и ANSI-варианты, перечислены фактические экспортированные имена для двух функций. Обычно это имя функции с суффиксом W или A (соответственно).