Função WsMarkHeaderAsUnderstood (webservices.h)

  • Artigo

Essa função marca um cabeçalho como "compreendido" pelo aplicativo.

O conjunto de cabeçalhos é extensível e a assimilação de mensagem pelo receptor não é acessível pelo remetente. Essa função é o método de recebimento de aplicativos para torná-la conhecida para o remetente que o cabeçalho recebido foi lido e compreendido.

Nota Essa função só deverá ser usada se o aplicativo receber uma mensagem indicando que o cabeçalho deve ser compreendido e não adquiriu o cabeçalho usando WsGetHeader ou WsGetCustomHeader.

O WS_MESSAGE_STATE deve estar no conjunto para WS_MESSAGE_STATE_READING. Ver. WsCheckMustUnderstandHeaders para obter mais informações.

 

Sintaxe

HRESULT WsMarkHeaderAsUnderstood(
  [in]           WS_MESSAGE                 *message,
  [in]           const WS_XML_NODE_POSITION *headerPosition,
  [in, optional] WS_ERROR                   *error
);

Parâmetros

[in] message

Um ponteiro para o objeto Message com o cabeçalho a ser marcado.

[in] headerPosition

Um ponteiro para a posição do elemento de cabeçalho dentro do segmento de cabeçalho XML.

[in, optional] error

Um ponteiro para um objeto WS_ERROR em que informações adicionais sobre o 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_OPERATION
 A mensagem não está no estado correto.
E_INVALIDARG
 Um ou mais argumentos são inválidos.
E_OUTOFMEMORY
 Ficou sem memória.
Outros erros
Essa função pode retornar outros erros não listados acima.

Comentários

Quando o aplicativo lê o cabeçalho usando um Leitor de XML, ele deve obter uma WS_XML_NODE_POSITION do elemento de cabeçalho e passá-lo para essa função. Consulte WsGetReaderPosition para saber como obter um WS_XML_NODE_POSITION.

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