Función WsGetCustomHeader (webservices.h)

Busca un encabezado definido por la aplicación del mensaje y lo deserializa.

Sintaxis

HRESULT WsGetCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *customHeaderDescription,
  [in]           WS_REPEATING_HEADER_OPTION   repeatingOption,
  [in]           ULONG                        headerIndex,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
                 ULONG                        *headerAttributes,
  [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] customHeaderDescription

Un WS_ELEMENT_DESCRIPTION que describe el elemento de encabezado.

[in] repeatingOption

Si el encabezado puede aparecer más de una vez en el mensaje.

Si se usa WS_REPEATING_HEADER , el índice de encabezado indica cuáles de los encabezados con el headerName especificado que se va a devolver.

Si se usa WS_SINGLETON_HEADER , headerIndex debe ser cero.

[in] headerIndex

Índice de base cero del encabezado dentro del conjunto de encabezados con el headerName especificado.

[in] readOption

Indica si el valor es necesario y cómo asignar el valor. 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, el montón de mensajes se usará según lo requiera el WS_READ_OPTION.

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.

headerAttributes

Devuelve el WS_HEADER_ATTRIBUTES de este encabezado. El puntero puede ser NULL, en cuyo caso no se devuelve ningún atributo.

[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. WS_SINGLETON_HEADER se especificó y hay varias instancias del tipo de encabezado presente 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 funciona en encabezados destinados al receptor final.
Esta API o ignora los encabezados destinados a un rol o actor que no sea el receptor final.

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