Win32 API
MSDNドキュメントの活用
サーチ…
前書き
Windows APIは広大で、多くの機能が含まれています。 APIのサイズは、誰もそれをすべて知ることができないようになっています。 StackOverflowのような多くのリソースがありますが、公式ドキュメントの代わりにはありません。
備考
ドキュメンテーションの例:
利用可能なドキュメントの種類
MSDNライブラリには、フィーチャの実装に使用できるさまざまな種類のドキュメントが含まれています。
- トピックの概要これらは、APIの一般的な理解を提供するためのトピックの概要です。これらの概要では、ベストプラクティスと実装戦略についても説明します。
- サンプル特定のAPIの使用方法を示します。これらは一般に非常に単純化されており、必ずしもエラーチェックを行う必要はなく、通常はMFCやATLのようなフレームワークを使用しません。それらは機能を使用するための出発点を提供します。
- 参照各APIのすべての要素を詳しく説明します。これには、定数/列挙型、インタフェース、関数、クラスが含まれます。
注:Microsoftの多くの従業員は、Raymond ChenのThe Old New Thingのようなブログをメンテナンスしていますが、これらのブログはドキュメントを補完するものではありません。
フィーチャのドキュメントの検索
フィーチャのドキュメントを見つけることは、良い検索エンジンを使用した検索と同じくらい簡単です。それが失敗した場合、または特定の用語について不明な場合は、 Windows API Indexを使用して特定の機能を特定できます。メソッド、インタフェース、列挙型および定数のドキュメントは、通常、検索エンジンを使用して名前を検索することによって見つけることができます。さらに、 Windows Dev Centerは貴重な出発点を提供します。
関数ドキュメントの使用
関数のドキュメントは、いくつかのセクションに分かれています。
概要
関数がどのように使用されているかを記述します。このセクションでは、関数が償却されるかどうか、また将来のバージョンでは使用できないかどうかについての情報も表示します。
構文
適切なソースヘッダーから関数の宣言を表示します。関数のシグネチャのクイックリファレンスです。
パラメーター
それぞれのパラメータ、そのパラメータが入力か出力か、その他の重要な考慮事項について説明します。
戻り値
このセクションでは、関数呼び出しの結果について説明します。関数の呼び出しには、エラーを検出する方法、追加情報があります。たとえば、 GetLastError
が追加のエラー処理情報を提供するかどうかを明示的に示します。
備考
機能の使用に関する情報、適切なハンドルの入手、リソースの廃棄など、機能の使用に必要な追加情報をすべてカバーします。
例
このセクションが利用可能な場合、実装の出発点として使用する関数の適切な使用例があります。
要件
関数を呼び出すための前提条件に関する重要な情報を提供します。この情報には、
- サポートされている最小限のクライアント/サーバー機能を提供するオペレーティングシステムの最初のバージョン(Microsoftがサポート)。
多くの場合、関数は以前のバージョンのオペレーティングシステムでサポートされていますが、このフィールドには現在Microsoftでサポートされている最も古いバージョンのみが表示されます(たとえば、CreateWindow
関数はWindows 1.0以降サポートされています) 。ドキュメントは、MSDNのドキュメントのオンライン版は、 任意の関数は、多くの人がいたにも関わらず、2000年以前にWindowsのバージョンでサポートされていたことを示していないWindows 2000からサポートされていることを示しています。従来の開発のために、しかし、あなたは意志MSDNのCD-ROMに同梱されているなど、古いバージョンのSDKドキュメントを参照するか、ヘッダーファイルを参照する必要があります)。 - ヘッダー関数の宣言を含む
#include
のSDKヘッダー。関数がヘッダーで利用できない場合は、関数を呼び出すプロシージャに関する情報が表示されます(通常、実行時の動的リンクを行うためにGetProcAddress
を呼び出します)。 - ライブラリエクスポートされた関数を解決するためにリンカーに渡すライブラリファイル。
- DLLエクスポートされた機能を含むファイル(オペレーティングシステムに付属)。
- クライアント/サーバーサポートの終了 APIを正式にサポートするWindowsの最終バージョン。
- UnicodeとANSIの名前UnicodeとANSIの両方のバリアントを持つ文字列関数の場合、2つの関数の実際にエクスポートされた名前がリストされます。これは通常、それぞれ接尾辞が
W
またはA
関数名です(それぞれ)。