WPRCFormatError は、HRESULT エラー コードに基づいてエラー メッセージをフォーマットするように設計された関数です。 エラー メッセージを取得する方法を提供します。
構文
HRESULT WPRCFormatError(
_In_ HRESULT Hresult,
_In_opt_ LPUNKNOWN pUnknown,
_Out_ BSTR* pbstrMessage,
_Out_opt_ BSTR* pbstrDescription,
_Out_opt_ BSTR* pbstrDetailedDescription
);
パラメーター
Hresult
(_In_ HRESULT): フォーマットする必要がある HRESULT エラー コード。 これは必須パラメーターです。
pUnknown
(_In_opt_ LPUNKNOWN): エラーをフォーマットするための追加のコンテキストを提供するオプションのインターフェイス ポインター。 使用しない場合は、 NULL でもかまいません。
pbstrMessage
(_Out_ BSTR*): プライマリ エラー メッセージを受け取る BSTR 文字列へのポインタ。 これは必須の出力パラメータです。
pbstrDescription
(_Out_opt_ BSTR*): エラーのより詳細な説明を受け取る BSTR 文字列へのオプションのポインタ。 必要なければ、 NULL でもかまいません。
pbstrDetailedDescription
(_Out_opt_ BSTR*): エラーのさらに詳細な説明を受け取る BSTR 文字列へのオプションのポインタ。 必要でなければ、 NULL でもかまいません。
戻り値
この関数は HRESULT コードを返します。 通常、実行が成功すれば S_OK によって示されます。 失敗は他の HRESULT コードによって示され、関数の実行中にエラーが発生したことを示します。