Función WsRemoveCustomHeader (webservices.h)

  • Artículo

Quita un encabezado personalizado del mensaje.

Esta función está diseñada para controlar los tipos de encabezados que aparecen una vez en el mensaje y están destinados al receptor final. Se omiten los encabezados destinados a un rol distinto del receptor final.

Sintaxis

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

Parámetros

[in] message

Puntero al objeto Message con el encabezado que se va a quitar.

El mensaje puede estar en cualquier estado excepto WS_MESSAGE_STATE_EMPTY.

[in] headerName

Puntero al objeto WS_XML_STRING que hace referencia al "nombre local" del elemento de encabezado que se va a quitar.

[in] headerNs

Puntero al objeto WS_XML_STRING que hace referencia al espacio de nombres del elemento de encabezado que se va a quitar.

[in, optional] error

Puntero a un objeto WS_ERROR donde se debe almacenar información adicional sobre el error si se produce un error en la función.

Valor devuelto

Esta función puede devolver uno de estos valores.

Código devuelto Descripción
WS_E_INVALID_FORMAT
 Hay varias instancias del tipo de encabezado presente en el mensaje.
E_OUTOFMEMORY
 No había suficiente memoria disponible para serializar el encabezado.
E_INVALIDARG
 Uno o varios de los parámetros son incorrectos.
Otros errores
Esta función puede devolver otros errores no enumerados anteriormente.

Comentarios

Si existe un encabezado del tipo especificado en el mensaje que se quita. Si el encabezado no existe, la función no realiza ninguna acción y se completa correctamente.

Requisitos

   
Cliente mínimo compatible Windows 7 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2008 R2 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado webservices.h
Library WebServices.lib
Archivo DLL WebServices.dll