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

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

  • Статья

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

Синтаксис

HRESULT WsSetHeader(
  [in]           WS_MESSAGE      *message,
  [in]           WS_HEADER_TYPE  headerType,
  [in]           WS_TYPE         valueType,
  [in]           WS_WRITE_OPTION writeOption,
                 const void      *value,
  [in]           ULONG           valueSize,
  [in, optional] WS_ERROR        *error
);

Параметры

[in] message

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

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

[in] headerType

Тип сериализуемого заголовка.

[in] valueType

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

[in] writeOption

Является ли элемент заголовка обязательным и как выделяется значение. WS_WRITE_NILLABLE_VALUE и WS_WRITE_NILLABLE_POINTER параметры записи нельзя указать, так как типы заголовков в WS_HEADER_TYPE не допускаются в соответствующих спецификациях стандартов. Дополнительные сведения см. в разделе WS_WRITE_OPTION .

value

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

[in] valueSize

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

[in, optional] error

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

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

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

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

Комментарии

Этот API позволяет задавать стандартные типы заголовков (см . WS_HEADER_TYPE). Для определяемых приложением типов заголовков используйте WsAddCustomHeader.

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

Если заголовок заданного типа (предназначенный для конечного получателя) уже существует в сообщении, он заменяется.

Требования

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