функция wiasParseEndorserString (wiamdef.h)
Функция wiasParseEndorserString анализирует строку утверждающего средства, заменив определяемые службой и поставщиком маркеры в строке со значениями, связанными с этими токенами.
Синтаксис
HRESULT wiasParseEndorserString(
[in] BYTE *pWiasContext,
LONG lFlags,
[out, optional] WIAS_ENDORSER_INFO *pInfo,
[out] BSTR *pOutputString
);
Параметры
[in] pWiasContext
Указатель на контекст элемента WIA (контекст элемента, содержащий свойство WIA_DPS_ENDORSER_STRING (описано в документации по пакету SDK для Microsoft Windows)).
lFlags
Зарезервировано для использования системы и должно иметь значение 0.
[out, optional] pInfo
Указатель на структуру WIAS_ENDORSER_INFO, содержащую количество страниц и список пар пользовательских токенов и значений. Может быть значение NULL.
[out] pOutputString
Указатель на расположение памяти, которое получает адрес поддерживаемой строки синтаксического анализа. ЕслиpOutputString не имеет значения NULL для записи, функция предполагает, что вызывающий объект выделил буфер; в противном случае служба WIA выделяет ее. Обратите внимание, что служба WIA предполагает, что строка результирующего средства MAX_PATH (определена в stdlib.h) длинными символами. Если драйвер ожидает, что строка будет длиннее, она должна выделить сам буфер. Если вызывающий объект выделяет буфер, он должен инициализировать содержимое буфера до нуля перед использованием этой функции.
Возвращаемое значение
При успешном выполнении функция возвращает S_OK.
Если функция завершается ошибкой, она возвращает стандартную ошибку COM или один из кодов ошибок WIA .
Замечания
Приложение задает свойство WIA_DPS_ENDORSER_STRING строке, которая может содержать определяемые службой токены WIA $DATE$, $TIME$, $PAGE_COUNT$, $DAY$, $MONTH$и $YEAR$, а также маркеры, определенные поставщиком. После вызова драйвера wiasParseEndorserStringстрока, указываемая pOutputString содержит копию строки в свойстве WIA_DPS_ENDORSER_STRING, но с любыми маркерами, замененными значениями, представленными маркерами. Например, если в приложении задано значение "Эта страница была отсканирована на $DATE$", а текущая дата — 1 октября 2000 года, результирующая строка выходных данных будет "Эта страница была сканирована на 2000/10/1".
Список стандартных маркеров поддержки WIA можно найти в wiadef.h.
Драйверы могут запросить, чтобы wiasParseEndorserString заменить значения для маркеров, определенных поставщиком, заполнив структуру WIAS_ENDORSER_VALUE для каждой пары токенов и значений, и упаковав все эти структуры в WIAS_ENDORSER_INFO структуре. В следующем примере показано, как можно использовать эту функцию.
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);
Предположим, что свойство WIA_DPS_ENDORSER_STRING содержит значение "Это $MY_TOKEN$", и что вызов wiasParseEndorserString был успешным, bstrResultingEndorser теперь будет содержать "Это мое значение".
Требования
| Требование | Ценность |
|---|---|
| целевая платформа | Настольный |
| заголовка | wiamdef.h (включая Wiamdef.h) |
| библиотеки | Wiaservc.lib |
| DLL | Wiaservc.dll |