Función WsSetHeader (webservices.h)

Agrega o reemplaza el encabezado estándar especificado en el mensaje.

Sintaxis

HRESULT WsSetHeader(
  [in]           WS_MESSAGE      *message,
  [in]           WS_HEADER_TYPE  headerType,
  [in]           WS_TYPE         valueType,
  [in]           WS_WRITE_OPTION writeOption,
                 const void      *value,
  [in]           ULONG           valueSize,
  [in, optional] WS_ERROR        *error
);

Parámetros

[in] message

Mensaje en el que se va a establecer el encabezado.

El mensaje puede estar en cualquier estado, pero WS_MESSAGE_STATE_EMPTY.

[in] headerType

Tipo de encabezado que se va a serializar.

[in] valueType

Tipo del valor que se va a serializar. Consulte WS_HEADER_TYPE para ver el conjunto de tipos admitidos para cada tipo de encabezado.

[in] writeOption

Si se requiere el elemento de encabezado y cómo se asigna el valor. no se pueden especificar WS_WRITE_NILLABLE_VALUE y WS_WRITE_NILLABLE_POINTER opciones de escritura, ya que no se permite que los tipos de encabezado de WS_HEADER_TYPE sean nillables en las especificaciones de estándares respectivas. Consulte WS_WRITE_OPTION para obtener más información.

value

Valor de encabezado que se va a serializar. Consulte WS_WRITE_OPTION para obtener más información.

[in] valueSize

Tamaño del valor que se serializa, en bytes.

[in, optional] error

Especifica dónde se debe almacenar información de error adicional 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 presentes 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

Esta API permite establecer tipos de encabezado estándar (consulte WS_HEADER_TYPE). Para los tipos de encabezado definidos por la aplicación, use WsAddCustomHeader.

Esta API está diseñada para controlar los tipos de encabezados que aparecen una vez en el mensaje y están destinados al receptor final. Esta API o omite los encabezados destinados a un rol o actor que no sea el receptor final.

Si ya existe un encabezado del tipo especificado (dirigido al receptor final) en el mensaje, se reemplaza.

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