wiasParseEndorserString 関数 (wiamdef.h)
wiasParseEndorserString 関数は、WIA サービス定義トークンとベンダー定義トークンをそれらのトークンに関連付けられた値に置き換えて、保証文字列を解析します。
構文
HRESULT wiasParseEndorserString(
[in] BYTE *pWiasContext,
LONG lFlags,
[out, optional] WIAS_ENDORSER_INFO *pInfo,
[out] BSTR *pOutputString
);
パラメーター
[in] pWiasContext
WIA Item コンテキストへのポインター (WIA_DPS_ENDORSER_STRING プロパティを含むアイテムのコンテキスト (Microsoft Windows SDKドキュメントで説明)。
lFlags
システム使用のために予約されており、0 に設定する必要があります。
[out, optional] pInfo
ページ数とカスタム トークンと値のペアのリストを含む WIAS_ENDORSER_INFO構造体への ポインター。 NULL を指定できます。
[out] pOutputString
解析された保証文字列のアドレスを受け取るメモリ位置へのポインター。 *pOutputString がエントリで NULL 以外の場合、関数は呼び出し元がバッファーを割り当てたと見なします。それ以外の場合、WIA サービスによって割り当てられます。 WIA サービスでは、結果として得られる 最大 保証文字列が ( stdlib.h で定義された) 長MAX_PATHであることを前提としています。 ドライバーが文字列の長さが予想される場合は、バッファー自体を割り当てる必要があります。 呼び出し元がバッファーを割り当てる場合は、この関数を使用する前にバッファーの内容を 0 に初期化する 必要があります 。
戻り値
成功すると、関数はS_OKを返します。
関数が失敗した場合は、標準 COM エラーまたは WIA エラー コードのいずれかが返されます。
注釈
アプリケーションは、WIA サービス定義トークン $DATE$、$TIME$、$PAGE_COUNT$、$DAY$、$MONTH$、$YEAR$、およびベンダー定義トークンを含むことができる文字列にWIA_DPS_ENDORSER_STRING プロパティを設定します。 ドライバーが wiasParseEndorserString を呼び出した後、 pOutputString が指す文字列には、WIA_DPS_ENDORSER_STRING プロパティ内の文字列のコピーが含まれますが、トークンが表す値に置き換えられたトークンが含まれます。 たとえば、アプリケーションで保証文字列を "this page was scanned on $DATE$" に設定し、現在の日付が 2000 年 10 月 1 日の場合、結果の出力文字列は "This page was scanned on 2000/10/1" になります。
標準 WIA 保証トークンの一覧は 、wiadef.h にあります。
ドライバーは、各トークンと値のペアのWIAS_ENDORSER_VALUE構造体を入力し、これらの構造体をすべてWIAS_ENDORSER_INFO構造体にパッケージ化することで、wiasParseEndorserString がベンダー定義トークンの値を置き換える必要があることを要求できます。 次の例は、この関数を使用する方法を示しています。
HRESULT hr = S_OK;
BSTR bstrResultingEndorser = NULL;
WIAS_ENDORSER_VALUE aMyTokens[] = {L"$MY_TOKEN$", L"My value"};
WIAS_ENDORSER_INFO Info = {0, 1, aMyTokens};
hr = wiasParseEndorserString(pWiasContext, 0,
&Info, &bstrResultingEndorser);
WIA_DPS_ENDORSER_STRING プロパティに "This is $MY_TOKEN$" が含まれており、 wiasParseEndorserString の呼び出しが成功したと仮定すると、 bstrResultingEndorser には "This is My value" が含まれるようになります。
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | デスクトップ |
| Header | wiamdef.h (Wiamdef.h を含む) |
| Library | Wiaservc.lib |
| [DLL] | Wiaservc.dll |