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

Функция WsCheckMustUnderstandHeaders (webservices.h)

  • Статья

Проверяет, были ли указанные заголовки поняты получателем.

Примечание Эта функция должна вызываться после того, как все заголовки будут прочитаны для полученного сообщения.

 

Синтаксис

HRESULT WsCheckMustUnderstandHeaders(
  [in]           WS_MESSAGE *message,
  [in, optional] WS_ERROR   *error
);

Параметры

[in] message

Указатель на структуру WS_MESSAGE , содержащую понятные заголовки.

[in, optional] error

Указатель на структуру WS_ERROR , в которой при сбое функции сохраняются дополнительные сведения об ошибке.

Возвращаемое значение

Если функция завершается успешно, она возвращает NO_ERROR; в противном случае возвращается код ошибки HRESULT.

Код возврата Описание
WS_E_INVALID_OPERATION
 Сообщение находится в неправильном состоянии. Дополнительные сведения см. в разделе «Примечания».
WS_E_INVALID_FORMAT
 Сбой проверки или неправильно сформировано сообщение.
E_INVALIDARG
 Один или несколько аргументов являются недопустимыми.
E_OUTOFMEMORY
 Недостаточно памяти для завершения операции.
Другие ошибки
Эта функция может возвращать другие ошибки, не перечисленные выше.

Комментарии

Так как набор заголовков является расширяемым, необходимо определить, было ли сообщение достаточно понято для обработки. Таким образом, отправитель может использовать эту функцию, чтобы указать, какие заголовки следует понимать, какие заголовки можно рассматривать как необязательные или информационные.

Стандартные заголовки адресации, такие как те, которые определены в WS_HEADER_TYPE, автоматически считаются понятными, даже если они никогда не считываются путем вызова WsGetHeader.

Также предполагается, что пользовательские заголовки, определяемые приложением, считываются WsGetCustomHeader . Вызов WsGetCustomHeader автоматически помечает определенный заголовок как понятный.

Для любого другого заголовка, обрабатываемого приложением, приложение должно явно пометить заголовок как понятный, вызвав WsMarkHeaderAsUnderstood. В противном случае заголовок считается непонятным.

Эта функция должна вызываться после того, как все заголовки будут прочитаны для полученного сообщения. Исключением из необходимости вызова этой функции является случай посредника, который пересылает сообщение на другой узел без изменения его идентификатора (идентификатора сообщения), так как конечный узел выполнит проверка.

Функция завершится ошибкой, если какой-либо из указанных заголовков не был понят. Если объект ошибки предоставлен функции, он будет заполнен сведениями, которые можно использовать для отправки ошибки (см . WsCreateFaultFromError).

Сообщение должно находиться в состоянии WS_MESSAGE_STATE_READING.

Требования

Требование Значение
Минимальная версия клиента Windows 7 [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 R2 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header webservices.h
Библиотека WebServices.lib
DLL WebServices.dll