IWiaErrorHandler::GetStatusDescription メソッド (wia_lh.h)

システム UI は、GetStatusDescription メソッドを呼び出して、ユーザーがこの情報を要求した場合に、エラーに関する追加情報をユーザーに提供します。 このメソッドは、ドライバーの UI 拡張機能によって実装されます。

構文

HRESULT GetStatusDescription(
  [in]  LONG      lFlags,
  [in]  IWiaItem2 *pWiaItem2,
  [in]  HRESULT   hrStatus,
  [out] BSTR      *pbstrDescription
);

パラメーター

[in] lFlags

現在使用されていません。 0 に設定する必要があります。

[in] pWiaItem2

転送される IWiaItem2 項目へのポインター。

[in] hrStatus

IWiaDataCallback::BandedDataCallbackなど、WIA 転送メソッドによって受信された状態コードを含む HRESULT 変数。

[out] pbstrDescription

転送中に発生した状態またはエラーの説明を受け取る BSTR へのポインター。 このパラメーターは NULL できません。 ドライバーは、SysAllocString 関数を使用して文字列を割り当てる必要があります。呼び出し元は、SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring) 関数を使用して文字列を解放する必要があります。

戻り値

エラーが発生した場合、または次のいずれかの標準 COM エラー コードを返します。

リターン コード	形容
S_OK	pbstrDescription パラメーターには、有効な BSTR ポインターが含まれています。
WIA_STATUS_NOT_HANDLED	hrStatus パラメーターの値は拡張機能では不明であり、説明はありません。

備考

アプリケーションが IWiaErrorHandler::GetStatusDescription 呼び出すには、エラー処理拡張機能へのインターフェイス ポインターを受け取るために、最初に IWiaItem2::GetExtension を呼び出す必要があります。 アプリケーションは "ErrorHandler" を bstrName として渡し、IID_IWiaErrorHandlerを riidExtensionInterface として渡す必要があります。 アプリケーションは、上位互換性を確保するために、lFlags として 0 を渡す必要があります。

IWiaErrorHandler::GetStatusDescription の実装では、IWiaErrorHandler::ReportStatus の実装が処理するすべてのデバイス 状態コード (hrStatus) のS_OKが返され、IWiaErrorHandler::ReportStatus が処理しないWIA_STATUS_NOT_HANDLEDが返されます。

必要条件

要件	価値
ターゲット プラットフォーム の	デスクトップ
ヘッダー	wia_lh.h (Wia_lh.h を含む)

関連項目

IWiaErrorHandlerの

IWiaErrorHandler::ReportStatus