función wiasParseEndorserString (wiamdef.h)
La función wiasParseEndorserString analiza una cadena de aprobador, reemplazando los tokens definidos por el servicio WIA y definidos por el proveedor en la cadena con valores asociados a esos tokens.
Sintaxis
HRESULT wiasParseEndorserString(
[in] BYTE *pWiasContext,
LONG lFlags,
[out, optional] WIAS_ENDORSER_INFO *pInfo,
[out] BSTR *pOutputString
);
Parámetros
[in] pWiasContext
Puntero a un contexto de elemento WIA (el contexto del elemento que contiene la propiedad WIA_DPS_ENDORSER_STRING (descrita en la documentación de Microsoft Windows SDK)).
lFlags
Reservado para uso del sistema y debe establecerse en 0.
[out, optional] pInfo
Puntero a una estructura de WIAS_ENDORSER_INFO que contiene el recuento de páginas y una lista de pares de token/valor personalizados. Puede ser NULL.
[out] pOutputString
Puntero a una ubicación de memoria que recibe la dirección de la cadena del aprobador analizado. Si *pOutputString no es NULL en la entrada, la función asume que el autor de la llamada asignó el búfer; de lo contrario, el servicio WIA lo asignará. Tenga en cuenta que el servicio WIA supone que la cadena de aprobador resultante máxima es MAX_PATH (definido en stdlib.h) caracteres largos. Si el controlador espera que la cadena sea más larga, debe asignar el propio búfer. Si el autor de la llamada asigna el búfer, debe inicializar el contenido del búfer en cero antes de usar esta función.
Valor devuelto
Si se ejecuta correctamente, la función devuelve S_OK.
Si se produce un error en la función, devuelve un error COM estándar o uno de los códigos de error de WIA.
Comentarios
Una aplicación establece la propiedad WIA_DPS_ENDORSER_STRING en una cadena que puede contener los tokens definidos por el servicio WIA $DATE$, $TIME$, $PAGE_COUNT$, $DAY$, $MONTH$y $YEAR$, así como tokens definidos por el proveedor. Después de que un controlador llame a wiasParseEndorserString, la cadena a la que apunta pOutputString contiene una copia de la cadena en WIA_DPS_ENDORSER_STRING propiedad, pero con los tokens reemplazados por los valores que representan los tokens. Por ejemplo, si la aplicación establece la cadena del aprobador en "Esta página se examinó en $DATE$" y la fecha actual fue el 1 de octubre de 2000, la cadena de salida resultante sería "Esta página se examinó en 2000/10/1".
La lista de tokens de aprobador wiA estándar se puede encontrar en wiadef.h.
Los controladores pueden solicitar que wiasParseEndorserString sustituya los valores de los tokens definidos por el proveedor rellenando una estructura de WIAS_ENDORSER_VALUE para cada par token/valor y empaquetando todas estas estructuras en una estructura de WIAS_ENDORSER_INFO . En el ejemplo siguiente se muestra cómo se puede usar esta función.
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);
Suponiendo que la propiedad WIA_DPS_ENDORSER_STRING contiene "This is $MY_TOKEN$" y que la llamada a wiasParseEndorserString se realizó correctamente, bstrResultingEndorser contendrá ahora "This is My value".
Requisitos
| Requisito | Value |
|---|---|
| Plataforma de destino | Escritorio |
| Encabezado | wiamdef.h (incluya Wiamdef.h) |
| Library | Wiaservc.lib |
| Archivo DLL | Wiaservc.dll |