wiasParseEndorserString 関数 (wiamdef.h)
wiasParseEndorserString 関数は、WIA サービス定義トークンとベンダー定義トークンを、それらのトークンに関連付けられている値に置き換えて、保証文字列を解析します。
構文
HRESULT wiasParseEndorserString(
[in] BYTE *pWiasContext,
LONG lFlags,
[out, optional] WIAS_ENDORSER_INFO *pInfo,
[out] BSTR *pOutputString
);
パラメーター
[in] pWiasContext
WIA 項目コンテキストへのポインター (WIA_DPS_ENDORSER_STRING プロパティを含む項目のコンテキスト (Microsoft Windows SDK ドキュメントで説明)。
lFlags
システム用に予約されており、0 に設定する必要があります。
[out, optional] pInfo
ページ数とカスタム トークンと値のペアのリストを含む WIAS_ENDORSER_INFO 構造体へのポインター。 NULL できます。
[out] pOutputString
解析された保証文字列のアドレスを受け取るメモリ位置へのポインター。 *pOutputString がエントリで NULL 以外の場合、関数は呼び出し元がバッファーを割り当てたと見なします。それ以外の場合、WIA サービスによって割り当てられます。 WIA サービスでは、結果の保証文字列 最大 MAX_PATH (stdlib.h で定義) の長さが想定されていることに注意してください。 ドライバーは、文字列が長くなることを想定している場合は、バッファー自体を割り当てる必要があります。 呼び出し元がバッファーを割り当てる場合 、この関数を使用する前にバッファーの内容をゼロに初期化 必要があります。
戻り値
成功すると、関数は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にあります。
ドライバーは、wiasParseEndorserString、各トークンと値のペアの WIAS_ENDORSER_VALUE 構造体を入力し、これらの構造体のすべてを WIAS_ENDORSER_INFO 構造体にパッケージ化することで、ベンダー定義トークンの値を置き換えるように要求できます。 次の例は、この関数を使用する方法を示しています。
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" が含まれるようになります。
必要条件
| 要件 | 価値 |
|---|---|
| ターゲット プラットフォーム の | デスクトップ |
| ヘッダー | wiamdef.h (Wiamdef.h を含む) |
| ライブラリ | Wiaservc.lib |
| DLL | Wiaservc.dll |