wiasParseEndorserString, fonction (wiamdef.h)
La fonction wiasParseEndorserString analyse une chaîne d’approbateur, en remplaçant les jetons définis par le service WIA et définis par le fournisseur dans la chaîne par des valeurs associées à ces jetons.
Syntaxe
HRESULT wiasParseEndorserString(
[in] BYTE *pWiasContext,
LONG lFlags,
[out, optional] WIAS_ENDORSER_INFO *pInfo,
[out] BSTR *pOutputString
);
Paramètres
[in] pWiasContext
Pointeur vers un contexte d’élément WIA (contexte de l’élément contenant la propriété WIA_DPS_ENDORSER_STRING (décrit dans la documentation du Kit de développement logiciel (SDK) Microsoft Windows).
lFlags
Réservé à l’utilisation du système et doit être défini sur 0.
[out, optional] pInfo
Pointeur vers une structure WIAS_ENDORSER_INFO contenant le nombre de pages et une liste de paires jeton/valeur personnalisées. Peut être NULL .
[out] pOutputString
Pointeur vers un emplacement de mémoire qui reçoit l’adresse de la chaîne d’avalisateur analysée. Si *pOutputString n’est pas NULL lors de l’entrée, la fonction part du principe que l’appelant a alloué la mémoire tampon ; sinon, le service WIA l’alloue. Notez que le service WIA part du principe que la chaîne d’avalisateur maximale résultante est MAX_PATH (définie dans stdlib.h) caractères longs. Si le pilote s’attend à ce que la chaîne soit plus longue, elle doit allouer la mémoire tampon elle-même. Si l’appelant alloue la mémoire tampon, il devez initialiser le contenu de la mémoire tampon sur zéro avant d’utiliser cette fonction.
Valeur de retour
En cas de réussite, la fonction retourne S_OK.
Si la fonction échoue, elle retourne une erreur COM standard ou l’un des codes d’erreur WIA .
Remarques
Une application définit la propriété WIA_DPS_ENDORSER_STRING sur une chaîne qui peut contenir les jetons définis par le service WIA $DATE$, $TIME$, $PAGE_COUNT$, $DAY$, $MONTH$ et $YEAR$, ainsi que les jetons définis par le fournisseur. Après qu’un pilote appelle wiasParseEndorserString, la chaîne pointée par pOutputString contient une copie de la chaîne dans WIA_DPS_ENDORSER_STRING propriété, mais avec tous les jetons remplacés par les valeurs représentées par les jetons. Par exemple, si l’application a défini la chaîne d’avalisateur sur « Cette page a été analysée sur $DATE$ », et que la date actuelle était le 1er octobre 2000, la chaîne de sortie résultante serait « Cette page a été analysée le 10/10/10/ 2000 ».
Vous trouverez la liste des jetons d’authentification WIA standard dans wiadef.h.
Les pilotes peuvent demander que wiasParseEndorserString remplacer les valeurs des jetons définis par le fournisseur en remplissant une structure WIAS_ENDORSER_VALUE pour chaque paire jeton/valeur, et en empaquetant toutes ces structures dans une structure WIAS_ENDORSER_INFO. L’exemple suivant montre comment cette fonction peut être utilisée.
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);
En supposant que la propriété WIA_DPS_ENDORSER_STRING contient « This is $MY_TOKEN$ », et que l’appel à wiasParseEndorserString a réussi, bstrResultingEndorser contiendra désormais « This is My value ».
Exigences
| Exigence | Valeur |
|---|---|
| plateforme cible | Bureau |
| d’en-tête | wiamdef.h (include Wiamdef.h) |
| bibliothèque | Wiaservc.lib |
| DLL | Wiaservc.dll |