XtfGetErrorText
指定したHRESULT について、ユーザーが理解しやすいエラー メッセージとユーザー アクション テキストを取得します。
構文
パラメーター
HResult型: HRESULT [in] エラー メッセージとユーザー アクション テキストを検索する
HRESULT です。
errorMessageBuffer型: PWSTR* [out] null 終端文字列としてエラー メッセージを受け取るバッファーへのポインターです。 必要なバッファーの長さを決定するには、このパラメーターを
nullptr に、errorMessageBufferLength パラメーターを 0 に設定します。 呼び出し時、errorMessageBufferLength は終端の null 文字を含む、必要なバッファーの WCHAR での長さに設定されます。
errorMessageBufferLength型: UINT32* [in, out] 入力ではエラー メッセージ バッファーの長さ (WCHAR 単位) です。 バッファーの長さには、終端の null 文字用の領域を含める必要があります。 出力では、errorMessageBuffer の必要な長さ (WCHAR 単位) です userActionTextBuffer
型: PWSTR* [out] null 終端文字列としてユーザー アクション テキストを受け取るバッファーへのポインターです。 必要なバッファーの長さを決定するには、このパラメーターを
nullptr に、userActionTextBufferLength パラメーターを 0 に設定します。 呼び出し時、userActionTextBufferLength は終端の null 文字を含む、必要なバッファーの WCHAR での長さに設定されます。
userActionTextBufferLength型: UINT32* [in, out] ユーザー アクション テキスト バッファーの長さ (WCHAR 単位) です。 バッファーの長さには、終端の null 文字用の領域を含める必要があります。
戻り値
型: HRESULT 成功した場合はS_OK を返します。それ以外の場合は HRESULT エラー コードを返します。
S_OK が返された場合、関数は成功しています。 errorMessageBuffer と userActionTextBuffer は、それぞれ指定された HRESULT のエラー メッセージとユーザー アクション テキストに設定されます。
HRESULT_FROM_WIN32(ERROR_MORE_DATA) が返された場合、errorMessageBuffer または userActionTextBuffer に指定されたバッファーが十分な大きさではありません。 errorMessageBufferLength と userActionTextBufferLength は、指定された HRESULT のエラー メッセージとユーザー アクション テキストのそれぞれに必要なバッファーの長さに設定されます。
その他の HRESULT コードが返された場合、予期しないエラーが発生したことを示します。
解説
XtfGetErrorText に渡された HRESULT が認識される XBOX Tools Framework (XTF) エラー コードでない場合、errorMessageBuffer は「Unspecified error」に設定されます。 この結果を使用して、指定された HRESULT が認識される XTF エラー コードかどうかを確認できます。 認識される XTF エラー コードの詳細については、XTF トランスポート エラー (NDA トピック) を参照してください。
要件
ヘッダー: xtfapi.h ライブラリ: XtfApi.lib サポートされているプラットフォーム: Windows (XBOX 本体ツール用)関連項目
XtfConsoleControlXBOX Tools Framework ネイティブ API リファレンス