wiasReadPropStr 関数 (wiamdef.h)

wiasReadPropStr 関数は、WIA 項目から文字列プロパティ値を取得します。

構文

HRESULT wiasReadPropStr(
  [in]            BYTE   *pWiasContext,
                  PROPID propid,
  [out]           BSTR   *pbstr,
  [out, optional] BSTR   *pbstrOld,
                  BOOL   bMustExist
);

パラメーター

[in] pWiasContext

WIA 項目コンテキストへのポインター。

propid

プロパティ識別子を指定します。

[out] pbstr

プロパティの文字列値の最初のバイトを受け取るメモリ位置へのポインター。

[out, optional] pbstrOld

プロパティの前の値の最初のバイトを受け取るメモリ位置へのポインター。 この情報が不要な場合は、このパラメーターを NULL 設定します。

bMustExist

プロパティが存在する必要があるかどうかを示します。 TRUE をに設定する場合は、プロパティが存在する必要があります。FALSE をに設定した場合、プロパティは存在する必要はありません。

戻り値

成功すると、関数はS_OKを返します。 関数が失敗すると、標準の COM エラーまたは WIA_ERROR_XXX エラーのいずれかが返されます (Microsoft Windows SDK のドキュメントで説明)。

備考

ミニドライバーは、この関数から受け取った文字列を使用して完了したら、文字列に使用されるメモリの割り当てを解除する必要があります。

必要条件

要件	価値
サポートされる最小クライアント	Microsoft Windows Me および Windows XP 以降のバージョンの Windows オペレーティング システムで使用できます。
ターゲット プラットフォーム の	デスクトップ
ヘッダー	wiamdef.h (Wiamdef.h を含む)
ライブラリ	Wiaservc.lib
DLL	Wiaservc.dll

関連項目

wiasReadPropBin を する

wiasReadPropFloat を する

wiasReadPropGuid を する

wiasReadPropLong を する

wiasWritePropStr を する