Função WsGetHeader (webservices.h)

Localiza um cabeçalho padrão específico na mensagem e desserializa-o.

Sintaxe

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

A mensagem que contém o cabeçalho.

A mensagem pode estar em qualquer estado , mas WS_MESSAGE_STATE_EMPTY.

[in] headerType

O tipo de cabeçalho a ser desserializado.

[in] valueType

O tipo de valor a ser desserializado. Consulte WS_HEADER_TYPE para o conjunto de tipos que correspondem a cada tipo de cabeçalho.

[in] readOption

Se o valor é necessário e como alocar o valor. WS_READ_NILLABLE_VALUE e WS_READ_NILLABLE_POINTER opções de leitura não podem ser especificadas, pois os tipos de cabeçalho em WS_HEADER_TYPE não têm permissão para serem anuláveis nas respectivas especificações de padrões. Consulte WS_READ_OPTION para obter mais informações.

[in, optional] heap

O heap no qual armazenar os dados de cabeçalho desserializado. Se for NULL, o heap de mensagens será usado.

value

A interpretação desse parâmetro depende do WS_READ_OPTION.

[in] valueSize

A interpretação desse parâmetro depende do WS_READ_OPTION.

[in, optional] error

Especifica onde informações adicionais de erro devem ser armazenadas se a função falhar.

Retornar valor

Essa função pode retornar um desses valores.

Código de retorno	Descrição
WS_E_INVALID_FORMAT	O cabeçalho não existe e é necessário. Há várias instâncias do tipo de cabeçalho presentes na mensagem. Os dados de entrada não estavam no formato esperado.
WS_E_QUOTA_EXCEEDED	A cota de tamanho do heap foi excedida.
E_OUTOFMEMORY	Não havia memória suficiente disponível para desserializar o cabeçalho.
E_INVALIDARG	Um ou mais dos parâmetros estão incorretos.
Outros erros	Essa função pode retornar outros erros não listados acima.

Comentários

Essa API fornece acesso a um conjunto de tipos de cabeçalho padrão (consulte WS_HEADER_TYPE). Para tipos de cabeçalho definidos pelo aplicativo, use WsGetCustomHeader.

Essa API foi projetada para manipular tipos de cabeçalhos que aparecem uma vez na mensagem e são direcionados para o receptor final. Cabeçalhos direcionados com uma função/ator que não seja o receptor final são ignorados por essa API.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 7 [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2008 R2 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	webservices.h
Biblioteca	WebServices.lib
DLL	WebServices.dll