Funzione wiasParseEndorserString (wiamdef.h)
La funzione wiasParseEndorserString analizza una stringa di approvatore, sostituendo i token definiti dal servizio WIA e definiti dal fornitore nella stringa con i valori associati a tali token.
Sintassi
HRESULT wiasParseEndorserString(
[in] BYTE *pWiasContext,
LONG lFlags,
[out, optional] WIAS_ENDORSER_INFO *pInfo,
[out] BSTR *pOutputString
);
Parametri
[in] pWiasContext
Puntatore a un contesto dell'elemento WIA (contesto dell'elemento contenente la proprietà WIA_DPS_ENDORSER_STRING (descritta nella documentazione di Microsoft Windows SDK).
lFlags
Riservato per l'uso del sistema e deve essere impostato su 0.
[out, optional] pInfo
Puntatore a una struttura WIAS_ENDORSER_INFO contenente il conteggio delle pagine e un elenco di coppie token/valore personalizzate. Può essere NULL.
[out] pOutputString
Puntatore a una posizione di memoria che riceve l'indirizzo della stringa del approvatore analizzato. Se *pOutputString non è NULL all'ingresso, la funzione presuppone che il chiamante abbia allocato il buffer; in caso contrario, il servizio WIA lo allocherà. Si noti che il servizio WIA presuppone che il stringa di approvazione massima risultante sia MAX_PATH (definita in stdlib.h) caratteri lunghi. Se il driver prevede che la stringa sia più lunga, deve allocare il buffer stesso. Se il chiamante alloca il buffer, deve inizializzare il contenuto del buffer su zero prima di usare questa funzione.
Valore restituito
In caso di esito positivo, la funzione restituisce S_OK.
Se la funzione ha esito negativo, restituisce un errore COM standard o uno dei codici di errore wia .
Osservazioni
Un'applicazione imposta la proprietà WIA_DPS_ENDORSER_STRING su una stringa che può contenere i token definiti dal servizio WIA $DATE$, $TIME$, $PAGE_COUNT$, $DAY$, $MONTH$e $YEAR$, nonché i token definiti dal fornitore. Dopo che un driver chiama wiasParseEndorserString, la stringa a cui punta pOutputString contiene una copia della stringa nella proprietà WIA_DPS_ENDORSER_STRING, ma con tutti i token sostituiti dai valori rappresentati dai token. Ad esempio, se l'applicazione imposta la stringa di approvazione su "Questa pagina è stata analizzata in $DATE$" e la data corrente era il 1° ottobre 2000, la stringa di output risultante sarà "Questa pagina è stata analizzata il 10/10/2000".
L'elenco dei token di approvazione WIA standard è disponibile in wiadef.h.
I driver possono richiedere che wiasParseEndorserString valori sostitutivi per i token definiti dal fornitore compilando una struttura WIAS_ENDORSER_VALUE per ogni coppia token/valore e creare il pacchetto di tutte queste strutture in una struttura WIAS_ENDORSER_INFO. Nell'esempio seguente viene illustrato come usare questa funzione.
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);
Supponendo che la proprietà WIA_DPS_ENDORSER_STRING contenga "This is $MY_TOKEN$" e che la chiamata a wiasParseEndorserString sia riuscita, bstrResultingEndorser ora conterrà "This is My value".
Fabbisogno
| Requisito | Valore |
|---|---|
| piattaforma di destinazione | Desktop |
| intestazione | wiamdef.h (include Wiamdef.h) |
| libreria | Wiaservc.lib |
| dll | Wiaservc.dll |