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

Добавляет указанный сопоставленный заголовок в сообщение.

Синтаксис

HRESULT WsAddMappedHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           WS_TYPE             valueType,
  [in]           WS_WRITE_OPTION     writeOption,
  [in]           const void          *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Параметры

[in] message

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

Сообщение может находиться в любом состоянии, кроме WS_MESSAGE_STATE_EMPTY (см. перечисление WS_MESSAGE_STATE .

[in] headerName

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

[in] valueType

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

[in] writeOption

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

[in] value

Значение заголовка для сериализации. Дополнительные сведения см. в перечислении WS_WRITE_OPTION .

[in] valueSize

Размер сериализуемого значения в байтах.

[in, optional] error

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

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

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

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

Комментарии

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

При использовании http-канала необходимо указать необходимые сопоставления перед вызовом этой функции для добавления заголовков. Дополнительные сведения см. в разделе WS_HTTP_MESSAGE_MAPPING.

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

Требования

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