XtfGetErrorText
指定した HRESULT のわかりやすいエラー メッセージとユーザー アクション テキストを取得します。
構文
HRESULT XtfGetErrorText(
HRESULT HResult,
PWSTR *errorMessageBuffer,
UINT32 *errorMessageBufferLength,
PWSTR *userActionTextBuffer,
UINT32 *userActionTextBufferLength
)
パラメーター
HResult
型: HRESULT
[in] HRESULT エラー メッセージとユーザー アクション テキストを検索する 。
errorMessageBuffer
型: PWSTR*
[out]null で終わる文字列としてエラー メッセージを受け取るバッファーへのポインター。 必要なバッファーの長さを確認するには、このパラメーターを nullptr に設定し、errorMessageBufferLength パラメーターを 0 に設定します。 呼び出すと、errorMessageBufferLength は、終端の null 文字を含めた必要なバッファーの長さ (WCHAR) に設定されます。
errorMessageBufferLength
型: UINT32*
[in, out] 入力時は、WCHAR のエラー メッセージ バッファーの長さです。 バッファーの長さには、終端の NULL 文字のためのスペースを含める必要があります。 出力時は、WCHAR での errorMessageBuffer の必要な長さです。
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 本体ツール用)