Función WsGetMappedHeader (webservices.h)

  • Artículo

Busca un encabezado asignado en el mensaje y lo deserializa.

Sintaxis

HRESULT WsGetMappedHeader(
  [in]           WS_MESSAGE                 *message,
  [in]           const WS_XML_STRING        *headerName,
  [in]           WS_REPEATING_HEADER_OPTION repeatingOption,
  [in]           ULONG                      headerIndex,
  [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] headerName

Nombre del encabezado asignado.

[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ál 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] valueType

Tipo de valor que se va a deserializar.

[in] readOption

Si el valor es necesario y cómo asignar el valor. Consulte WS_READ_OPTION para obtener más información.

Si el encabezado es opcional (puede aparecer cero o una vez), se puede usar WS_READ_OPTIONAL_POINTER .

[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.

Los datos de entrada no tenían el formato esperado.

WS_SINGLETON_HEADER se especificó y hay varias instancias del encabezado con el nombre especificado en el mensaje.
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

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 objeto Message. Esta función se usa para leer un encabezado asignado por un transporte al mensaje.

Cuando se usa el canal HTTP, se deben especificar las asignaciones necesarias para poder extraer los encabezados con esta función. Para obtener más información, consulte WS_HTTP_MESSAGE_MAPPING.

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