Função WsCheckMustUnderstandHeaders (webservices.h)

Verifica se os cabeçalhos especificados foram compreendidos pelo receptor.

Nota Essa função deve ser chamada depois que todos os cabeçalhos tiverem sido lidos para uma mensagem recebida.

 

Sintaxe

HRESULT WsCheckMustUnderstandHeaders(
  [in]           WS_MESSAGE *message,
  [in, optional] WS_ERROR   *error
);

Parâmetros

[in] message

Ponteiro para a estrutura WS_MESSAGE que contém os cabeçalhos a serem compreendidos.

[in, optional] error

Ponteiro para uma estrutura WS_ERROR em que informações de erro adicionais são armazenadas se a função falhar.

Retornar valor

Se a função for bem-sucedida, ela retornará NO_ERROR; caso contrário, ele retorna um código de erro HRESULT.

Código de retorno	Descrição
WS_E_INVALID_OPERATION	A mensagem não está no estado correto. Para obter mais informações, consulte a seção Comentários.
WS_E_INVALID_FORMAT	A validação falhou ou a mensagem não foi formada corretamente.
E_INVALIDARG	Um ou mais argumentos são inválidos.
E_OUTOFMEMORY	Memória insuficiente para concluir a operação.
Outros erros	Essa função pode retornar outros erros não listados acima.

Comentários

Como o conjunto de cabeçalhos é extensível, é necessário determinar se uma mensagem foi suficientemente compreendida para ser processada. Portanto, o remetente pode usar essa função para indicar quais cabeçalhos devem ser compreendidos, quais cabeçalhos podem ser tratados como opcionais ou informativos.

Cabeçalhos de endereçamento padrão, como os definidos em WS_HEADER_TYPE, são automaticamente considerados compreendidos, mesmo que nunca sejam lidos chamando WsGetHeader.

Cabeçalhos personalizados definidos pelo aplicativo que são lidos por WsGetCustomHeader também são considerados compreendidos. Chamar WsGetCustomHeader marcará automaticamente o cabeçalho específico, conforme compreendido.

Para qualquer outro cabeçalho processado pelo aplicativo, o aplicativo deve marcar explicitamente o cabeçalho conforme compreendido chamando WsMarkHeaderAsUnderstood. Caso contrário, o cabeçalho será considerado como não compreendido.

Essa função deve ser chamada depois que todos os cabeçalhos tiverem sido lidos para uma mensagem recebida. Uma exceção à necessidade de chamar essa função é o caso de um intermediário que encaminha a mensagem para outro nó sem alterar sua identidade (ID da mensagem), pois o nó final fará o marcar.

A função falhará se qualquer um dos cabeçalhos especificados não for compreendido. Se um objeto de erro for fornecido à função, ele será preenchido com informações que podem ser usadas para enviar uma falha (consulte WsCreateFaultFromError).

A mensagem deve estar no estado WS_MESSAGE_STATE_READING.

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