Função wiasParseEndorserString (wiamdef.h)
A função wiasParseEndorserString analisa uma cadeia de caracteres de endossador, substituindo tokens definidos pelo serviço WIA e definidos pelo fornecedor na cadeia de caracteres por valores associados a esses tokens.
Sintaxe
HRESULT wiasParseEndorserString(
[in] BYTE *pWiasContext,
LONG lFlags,
[out, optional] WIAS_ENDORSER_INFO *pInfo,
[out] BSTR *pOutputString
);
Parâmetros
[in] pWiasContext
Ponteiro para um contexto de Item wia (o contexto do item que contém a propriedade WIA_DPS_ENDORSER_STRING (descrito na documentação SDK do Microsoft Windows)).
lFlags
Reservado para uso do sistema e deve ser definido como 0.
[out, optional] pInfo
Ponteiro para uma estrutura de WIAS_ENDORSER_INFO que contém a contagem de páginas e uma lista de pares de token/valor personalizados. Pode ser NULL.
[out] pOutputString
Ponteiro para um local de memória que recebe o endereço da cadeia de caracteres do endossador analisada. Se *pOutputString não for NULL na entrada, a função pressupõe que o chamador alocou o buffer; caso contrário, o serviço WIA o alocará. Observe que o serviço WIA pressupõe que a cadeia de caracteres de endossador resultante máxima seja MAX_PATH (definida em stdlib.h) caracteres longos. Se o driver espera que a cadeia de caracteres seja mais longa, ele deverá alocar o próprio buffer. Se o chamador alocar o buffer, ele deverá inicializar o conteúdo do buffer como zero antes de usar essa função.
Retornar valor
Em caso de êxito, a função retorna S_OK.
Se a função falhar, ela retornará um erro COM padrão ou um dos códigos de erro wia.
Comentários
Um aplicativo define a propriedade WIA_DPS_ENDORSER_STRING como uma cadeia de caracteres que pode conter os tokens definidos pelo serviço WIA $DATE$, $TIME$, $PAGE_COUNT$, $DAY$, $MONTH$e $YEAR$, bem como tokens definidos pelo fornecedor. Depois que um driver chama wiasParseEndorserString, a cadeia de caracteres apontada por pOutputString contém uma cópia da cadeia de caracteres na propriedade WIA_DPS_ENDORSER_STRING, mas com todos os tokens substituídos pelos valores que os tokens representam. Por exemplo, se o aplicativo definir a cadeia de caracteres do endossador como "Esta página foi verificada em $DATE$", e a data atual fosse 1º de outubro de 2000, a cadeia de caracteres de saída resultante seria "Esta página foi verificada em 10/10/2000".
A lista de tokens de endossador WIA padrão pode ser encontrada em wiadef.h.
Os drivers podem solicitar que wiasParseEndorserString substitua valores por tokens definidos pelo fornecedor preenchendo uma estrutura WIAS_ENDORSER_VALUE para cada par de token/valor e empacotando todas essas estruturas em uma estrutura WIAS_ENDORSER_INFO . O exemplo a seguir mostra como essa função pode ser usada.
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);
Supondo que a propriedade WIA_DPS_ENDORSER_STRING contenha "This is $MY_TOKEN$" e que a chamada para wiasParseEndorserString tenha sido bem-sucedida, bstrResultingEndorser agora conterá "Este é meu valor".
Requisitos
| Requisito | Valor |
|---|---|
| Plataforma de Destino | Área de Trabalho |
| Cabeçalho | wiamdef.h (inclua Wiamdef.h) |
| Biblioteca | Wiaservc.lib |
| DLL | Wiaservc.dll |