wiasParseEndorserString-Funktion (wiamdef.h)

Die wiasParseEndorserString-Funktion analysiert eine Endorserzeichenfolge und ersetzt wiA-dienstdefinierte und vom Anbieter definierte Token in der Zeichenfolge durch Werte, die diesen Token zugeordnet sind.

Syntax

HRESULT wiasParseEndorserString(
  [in]            BYTE               *pWiasContext,
                  LONG               lFlags,
  [out, optional] WIAS_ENDORSER_INFO *pInfo,
  [out]           BSTR               *pOutputString
);

Parameter

[in] pWiasContext

Zeiger auf einen WIA-Elementkontext (der Kontext des Elements, das die eigenschaft WIA_DPS_ENDORSER_STRING enthält (in der Microsoft Windows SDK-Dokumentation beschrieben)).

lFlags

Für die Systemverwendung reserviert und sollte auf 0 festgelegt werden.

[out, optional] pInfo

Zeiger auf eine WIAS_ENDORSER_INFO-Struktur , die die Seitenanzahl und eine Liste benutzerdefinierter Token-Wert-Paare enthält. Kann NULL sein.

[out] pOutputString

Zeiger auf einen Speicherspeicherort, der die Adresse der analysierten Endorserzeichenfolge empfängt. Wenn *pOutputString beim Eintrag nicht NULL ist, geht die Funktion davon aus, dass der Aufrufer den Puffer zugewiesen hat. andernfalls ordnet der WIA-Dienst sie zu. Beachten Sie, dass der WIA-Dienst davon ausgeht, dass die maximal resultierende Endorserzeichenfolge MAX_PATH (in stdlib.h definiert) Zeichen lang ist. Wenn der Treiber erwartet, dass die Zeichenfolge länger ist, sollte er den Puffer selbst zuordnen. Wenn der Aufrufer den Puffer zuordnet, muss er den Inhalt des Puffers auf Null initialisieren, bevor er diese Funktion verwendet.

Rückgabewert

Bei Erfolg gibt die Funktion S_OK zurück.

Wenn die Funktion fehlschlägt, gibt sie einen COM-Standardfehler oder einen der WIA-Fehlercodes zurück.

Hinweise

Eine Anwendung legt die WIA_DPS_ENDORSER_STRING-Eigenschaft auf eine Zeichenfolge fest, die die vom WIA-Dienst definierten Token $DATE$, $TIME$, $PAGE_COUNT$, $DAY$, $MONTH$ und $YEAR$sowie vom Anbieter definierte Token enthalten kann. Nachdem ein Treiber wiasParseEndorserString aufgerufen hat, enthält die Zeichenfolge, auf die von pOutputString verwiesen wird, eine Kopie der Zeichenfolge in WIA_DPS_ENDORSER_STRING Eigenschaft, aber alle Token werden durch die Werte ersetzt, die die Token darstellen. Wenn die Anwendung beispielsweise die Zeichenfolge des Endorsers auf "This page was scanned on $DATE$" festgelegt hat und das aktuelle Datum der 1. Oktober 2000 war, würde die resultierende Ausgabezeichenfolge "This page was scanned on 2000/10/1" (Diese Seite wurde am 10.10.2000 gescannt) festgelegt.

Die Liste der standardmäßigen WIA-Unterstützungstoken finden Sie in wiadef.h.

Treiber können anfordern, dass wiasParseEndorserString Werte für vom Anbieter definierte Token ersetzt, indem sie eine WIAS_ENDORSER_VALUE-Struktur für jedes Token-Wert-Paar ausfüllen und alle diese Strukturen in einer WIAS_ENDORSER_INFO-Struktur packen. Das folgende Beispiel zeigt, wie diese Funktion verwendet werden kann.

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);

Wenn die WIA_DPS_ENDORSER_STRING-Eigenschaft "This is $MY_TOKEN$" enthält und der Aufruf von wiasParseEndorserString erfolgreich war, enthält bstrResultingEndorser jetzt "This is My value".

Anforderungen

Weitere Informationen

WIAS_ENDORSER_INFO

WIAS_ENDORSER_VALUE