Функция wiasParseEndorserString (wiamdef.h)

Статья
02/27/2024

Функция wiasParseEndorserString анализирует строку одобрителя, заменяя определяемые службой и поставщиком токены WIA в строке значениями, связанными с этими токенами.

Синтаксис

HRESULT wiasParseEndorserString(
  [in]            BYTE               *pWiasContext,
                  LONG               lFlags,
  [out, optional] WIAS_ENDORSER_INFO *pInfo,
  [out]           BSTR               *pOutputString
);

Параметры

[in] pWiasContext

Указатель на контекст элемента WIA (контекст элемента, содержащего свойство WIA_DPS_ENDORSER_STRING (описано в документации по Microsoft Windows SDK)).

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 г., итоговой строкой вывода будет "Эта страница была проверена на 10.01.2000".

Список стандартных токенов индоссывателя 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 содержит "This is $MY_TOKEN$" и что вызов wiasParseEndorserString выполнен успешно, bstrResultingEndorser теперь будет содержать "This is My value".

Требования

Требование	Значение
Целевая платформа	Персональный компьютер
Верхняя часть	wiamdef.h (включая Wiamdef.h)
Библиотека	Wiaservc.lib
DLL	Wiaservc.dll

См. также раздел

WIAS_ENDORSER_INFO

WIAS_ENDORSER_VALUE

Поделиться через