Función WsAddMappedHeader (webservices.h)

Agrega un encabezado asignado especificado al mensaje.

Sintaxis

HRESULT WsAddMappedHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           WS_TYPE             valueType,
  [in]           WS_WRITE_OPTION     writeOption,
  [in]           const void          *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Parámetros

[in] message

Puntero a una estructura WS_MESSAGE que representa el mensaje al que se va a agregar el encabezado asignado.

El mensaje puede estar en cualquier estado excepto WS_MESSAGE_STATE_EMPTY (vea la enumeración WS_MESSAGE_STATE .

[in] headerName

Puntero a un WS_XML_STRING que contiene el nombre del encabezado.

[in] valueType

Tipo de valor de encabezado que se va a deserializar. Para conocer los posibles tipos y los encabezados correspondientes, consulte el WS_HEADER_TYPE

[in] writeOption

Indica si se requiere el encabezado y cómo se asigna el valor. Para obtener más información, vea la enumeración WS_WRITE_OPTION .

[in] value

Valor de encabezado que se va a serializar. Para obtener más información, vea la enumeración WS_WRITE_OPTION .

[in] valueSize

Tamaño del valor que se va a serializar, en bytes.

[in, optional] error

Puntero a una estructura de WS_ERROR que recibe información de error adicional si se produce un error en la función.

Valor devuelto

Si la función se realiza correctamente, devuelve NO_ERROR; de lo contrario, devuelve un código de error HRESULT.

Código devuelto	Descripción
E_OUTOFMEMORY	Memoria insuficiente para completar la operación.
E_INVALIDARG	Uno o varios de los parámetros son incorrectos.
Otros errores	Esta función puede devolver otros errores no enumerados anteriormente.

Comentarios

Un mensaje puede contener información adicional específica del transporte que no forma parte del sobre del mensaje. Esta información específica del transporte se puede exponer mediante programación como encabezados del mensaje. La función WsAddMappedHeader se usa para agregar un encabezado de este tipo que se asignará a alguna ubicación específica del transporte.

Al usar el canal HTTP, debe especificar las asignaciones necesarias antes de llamar a esta función para agregar los encabezados. Para obtener más información, consulte WS_HTTP_MESSAGE_MAPPING.

Si va a reemplazar un encabezado, llame a la función WsRemoveMappedHeader para quitar las instancias existentes del encabezado antes de llamar a WsAddMappedHeader.

Requisitos

Requisito	Value
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