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

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

  • Статья

Находит определяемый приложением заголовок сообщения и десериализует его.

Синтаксис

HRESULT WsGetCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *customHeaderDescription,
  [in]           WS_REPEATING_HEADER_OPTION   repeatingOption,
  [in]           ULONG                        headerIndex,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
                 ULONG                        *headerAttributes,
  [in, optional] WS_ERROR                     *error
);

Параметры

[in] message

Сообщение, содержащее заголовок .

Сообщение может находиться в любом состоянии, но WS_MESSAGE_STATE_EMPTY.

[in] customHeaderDescription

WS_ELEMENT_DESCRIPTION, описывающий элемент заголовка.

[in] repeatingOption

Указывает, может ли заголовок отображаться в сообщении несколько раз.

Если используется WS_REPEATING_HEADER , индекс заголовка указывает, какой из заголовков с указанным headerName нужно вернуть.

Если используется WS_SINGLETON_HEADER , то заголовокIndex должен быть равен нулю.

[in] headerIndex

Отсчитываемый от нуля индекс заголовка в наборе заголовков с указанным headerName.

[in] readOption

Является ли значение обязательным и как его выделить. Дополнительные сведения см. в разделе WS_READ_OPTION .

[in, optional] heap

Куча для хранения десериализованных данных заголовка. Если это значение равно NULL, то куча сообщений будет использоваться в соответствии с требованиями WS_READ_OPTION.

value

Интерпретация этого параметра зависит от WS_READ_OPTION.

[in] valueSize

Интерпретация этого параметра зависит от WS_READ_OPTION.

headerAttributes

Возвращает WS_HEADER_ATTRIBUTES для этого заголовка. Указатель может иметь значение NULL, в этом случае атрибуты не возвращаются.

[in, optional] error

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

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

Эта функция может возвращать одно из этих значений.

Код возврата Описание
WS_E_INVALID_FORMAT
 Заголовок не существует и является обязательным.

WS_SINGLETON_HEADER указано, и в сообщении имеется несколько экземпляров типа заголовка.

Входные данные не были в ожидаемом формате.
WS_E_QUOTA_EXCEEDED
 Превышена квота размера кучи.
E_OUTOFMEMORY
 Недостаточно памяти для десериализации заголовка.
E_INVALIDARG
 Один или несколько параметров неверны.
Другие ошибки
Эта функция может возвращать другие ошибки, не перечисленные выше.

Комментарии

Этот API работает с заголовками, предназначенными для конечного получателя.
Заголовки, предназначенные для роли или субъекта, отличного от конечного получателя, игнорируются этим API.

Требования

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