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

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

  • Статья

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

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

Синтаксис

HRESULT WsRemoveCustomHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           const WS_XML_STRING *headerNs,
  [in, optional] WS_ERROR            *error
);

Параметры

[in] message

Указатель на объект Message с удаляемым заголовком.

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

[in] headerName

Указатель на объект WS_XML_STRING , который ссылается на локальное имя удаляемого элемента заголовка.

[in] headerNs

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

[in, optional] error

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

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

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

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

Комментарии

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

Требования

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