Compartilhar via

Função WsGetMappedHeader (webservices.h)

  • Artigo

Localiza um cabeçalho mapeado na mensagem e desserializa-o.

Sintaxe

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

A mensagem que contém o cabeçalho.

A mensagem pode estar em qualquer estado , mas WS_MESSAGE_STATE_EMPTY.

[in] headerName

O nome do cabeçalho mapeado.

[in] repeatingOption

Se o cabeçalho pode aparecer mais de uma vez na mensagem.

Se WS_REPEATING_HEADER for usado, o índice de cabeçalho indicará qual dos cabeçalhos com o headerName especificado retornará.

Se WS_SINGLETON_HEADER for usado, o headerIndex deverá ser zero.

[in] headerIndex

O índice baseado em zero do cabeçalho dentro do conjunto de cabeçalhos com o headerName especificado.

[in] valueType

O tipo de valor a ser desserializado.

[in] readOption

Se o valor é necessário e como alocar o valor. Consulte WS_READ_OPTION para obter mais informações.

Se o cabeçalho for opcional (pode aparecer zero ou uma vez), WS_READ_OPTIONAL_POINTER poderá ser usado.

[in, optional] heap

O heap no qual armazenar os dados de cabeçalho desserializados. 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.

Os dados de entrada não estavam no formato esperado.

WS_SINGLETON_HEADER foi especificado e há várias instâncias do cabeçalho com o nome especificado na mensagem.
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

Uma mensagem pode conter informações adicionais específicas do transporte que não fazem parte do envelope da mensagem. Essas informações específicas do transporte podem ser expostas programaticamente como cabeçalhos do objeto Message. Essa função é usada para ler um cabeçalho que foi mapeado por um transporte para a mensagem.

Ao usar o canal HTTP, os mapeamentos necessários devem ser especificados antes que os cabeçalhos possam ser extraídos com essa função. Para obter mais informações, consulte WS_HTTP_MESSAGE_MAPPING.

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