Función WsGetHeader (webservices.h)

  • Artículo

Busca un encabezado estándar determinado en el mensaje y lo deserializa.

Sintaxis

HRESULT WsGetHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [in]           WS_TYPE        valueType,
  [in]           WS_READ_OPTION readOption,
  [in, optional] WS_HEAP        *heap,
                 void           *value,
  [in]           ULONG          valueSize,
  [in, optional] WS_ERROR       *error
);

Parámetros

[in] message

Mensaje que contiene el encabezado .

El mensaje puede estar en cualquier estado, pero WS_MESSAGE_STATE_EMPTY.

[in] headerType

Tipo de encabezado que se va a deserializar.

[in] valueType

Tipo de valor que se va a deserializar. Consulte WS_HEADER_TYPE para el conjunto de tipos que corresponden a cada tipo de encabezado.

[in] readOption

Si el valor es necesario y cómo asignar el valor. no se pueden especificar WS_READ_NILLABLE_VALUE y WS_READ_NILLABLE_POINTER opciones de lectura, 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_READ_OPTION para obtener más información.

[in, optional] heap

Montón en el que se almacenarán los datos de encabezado deserializados. Si es NULL, se usará el montón de mensajes.

value

La interpretación de este parámetro depende del WS_READ_OPTION.

[in] valueSize

La interpretación de este parámetro depende del WS_READ_OPTION.

[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
 El encabezado no existe y es necesario.

Hay varias instancias del tipo de encabezado presentes en el mensaje.

Los datos de entrada no tenían el formato esperado.
WS_E_QUOTA_EXCEEDED
 Se superó la cuota de tamaño del montón.
E_OUTOFMEMORY
 No había suficiente memoria disponible para deserializar 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 proporciona acceso a un conjunto de tipos de encabezado estándar (consulte WS_HEADER_TYPE). Para los tipos de encabezado definidos por la aplicación, use WsGetCustomHeader.

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.

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