Função WsGetCustomHeader (webservices.h)

  • Artigo

Localiza um cabeçalho definido pelo aplicativo da mensagem e a desserializa.

Sintaxe

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

A mensagem que contém o cabeçalho.

A mensagem pode estar em qualquer estado , mas WS_MESSAGE_STATE_EMPTY.

[in] customHeaderDescription

Um WS_ELEMENT_DESCRIPTION que descreve o elemento de cabeçalho.

[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] readOption

Se o valor é necessário e como alocar o valor. 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 conforme exigido pelo WS_READ_OPTION.

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.

headerAttributes

Retorna o WS_HEADER_ATTRIBUTES desse cabeçalho. O ponteiro pode ser NULL, caso em que nenhum atributo é retornado.

[in, optional] error

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

Valor retornado

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.

WS_SINGLETON_HEADER foi especificado e 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 opera em cabeçalhos direcionados ao receptor final.
Cabeçalhos direcionados com uma função/ator que não seja o receptor final são ignorados por essa API.

Requisitos

   
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