IWiaMiniDrv::d rvGetDeviceErrorStr メソッド (wiamindr_lh.h)

IWiaMiniDrv::d rvGetDeviceErrorStr メソッドは、エラーを記述する Unicode 文字列にエラー コードをマップします。

構文

HRESULT drvGetDeviceErrorStr(
  LONG     __MIDL__IWiaMiniDrv0039,
  LONG     __MIDL__IWiaMiniDrv0040,
  LPOLESTR *__MIDL__IWiaMiniDrv0041,
  LONG     *__MIDL__IWiaMiniDrv0042
);

パラメーター

__MIDL__IWiaMiniDrv0039

lDevErrVal [in]

文字列にマップするデバイス エラー値を指定します。 値が 0 の場合は、エラーが発生しなかったことを示します。

__MIDL__IWiaMiniDrv0040

lFlags [in]

引っ込み思案。

__MIDL__IWiaMiniDrv0041

plDevErr [out]

このメソッドの状態コードを受け取るメモリの場所を指します。 このメソッドが S_OKを返す場合、格納される値は 0 になります。 それ以外の場合、ミニドライバー固有のエラー コードは、このパラメーターが指す場所に格納されます。

__MIDL__IWiaMiniDrv0042

ppszDevErrStr [out, optional]

エラーを説明する文字列のアドレスを受け取るメモリの場所を指します。

戻り値

成功した場合、メソッドは S_OK を返し、plDevErr によって指デバイス エラー値をクリアする必要があります。 ミニドライバーがこのメソッドを完全に実装していない場合、メソッドは E_NOTIMPLを返す必要があります。 ミニドライバーがこのメソッドに渡されたエラー値を認識しない場合、メソッドは E_INVALIDARGを返す必要があります。 メソッドが失敗した場合は、標準の COM エラー コードを返し、ミニドライバー固有のエラー コード値 plDevErrが指すメモリに配置する必要があります。

備考

デバイス固有のミニドライバーによって生成されたエラー値を記述するエラー文字列を取得するには、WIA サービスは、IWiaMiniDrv::d rvGetDeviceErrorStr メソッドを呼び出します。 この呼び出しに応じて、ミニドライバーは、CoTaskMemAlloc を使用して、ミニドライバーに渡されたエラー コードに対応するローカライズされた Unicode 文字列を含むメモリを割り当てる必要があります。 WIA サービス (またはアプリケーション) によってメモリが解放されます。 アプリケーションで文字列が表示される可能性が高いので、エンド ユーザーにとって意味のあるものにする必要があります。 文字列は、さまざまな言語にローカライズできるように、リソース ファイルから読み込む必要があります。

必要条件

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