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

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

  • Статья

Удаляет стандартный объект WS_HEADER_TYPE из сообщения.

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

Для определяемых приложением типов заголовков используйте функцию WsRemoveCustomHeader .

Синтаксис

HRESULT WsRemoveHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [in, optional] WS_ERROR       *error
);

Параметры

[in] message

Указатель на объект Message с удаляемым заголовком. Сообщение может находиться в любом состоянии, кроме WS_MESSAGE_STATE_EMPTY.

[in] headerType

Указывает тип удаляемого заголовка.

[in, optional] error

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

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

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

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

Комментарии

Если заголовок данного типа существует в сообщении, он удаляется. Если заголовок не существует, никакие действия не выполняются и функция завершается успешно.

Требования

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