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

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

  • Статья

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

Синтаксис

HRESULT WsAddCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *headerDescription,
  [in]           WS_WRITE_OPTION              writeOption,
  [in, ref]      const void                   *value,
  [in]           ULONG                        valueSize,
  [in]           ULONG                        headerAttributes,
  [in, optional] WS_ERROR                     *error
);

Параметры

[in] message

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

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

[in] headerDescription

Структура WS_ELEMENT_DESCRIPTION , описывающая заголовок.

[in] writeOption

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

[in, ref] value

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

[in] valueSize

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

[in] headerAttributes

Значения атрибутов SOAP для заголовка.

[in, optional] error

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

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

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

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

Комментарии

Функция WsAddCustomHeader предназначена для обработки типов заголовков, предназначенных для конечного получателя. Заголовки, предназначенные для другого получателя, игнорируются.

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

Требования

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