Função WsRemoveCustomHeader (webservices.h)

  • Artigo

Remove um cabeçalho personalizado da mensagem.

Essa função foi projetada para lidar com tipos de cabeçalhos que aparecem uma vez na mensagem e são direcionados para o receptor final. Os cabeçalhos direcionados com uma função diferente do receptor final são ignorados.

Sintaxe

HRESULT WsRemoveCustomHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           const WS_XML_STRING *headerNs,
  [in, optional] WS_ERROR            *error
);

Parâmetros

[in] message

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

A mensagem pode estar em qualquer estado, exceto WS_MESSAGE_STATE_EMPTY.

[in] headerName

Um ponteiro para o objeto WS_XML_STRING que faz referência ao "nome local" do elemento de cabeçalho a ser removido.

[in] headerNs

Um ponteiro para o objeto WS_XML_STRING que faz referência ao namespace do elemento de cabeçalho a ser removido.

[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.

Valor retornado

Essa função pode retornar um desses valores.

Código de retorno Descrição
WS_E_INVALID_FORMAT
 Há várias instâncias do tipo de cabeçalho presentes na mensagem.
E_OUTOFMEMORY
 Não havia memória suficiente disponível para serializar 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

Se um cabeçalho do tipo fornecido existir na mensagem, ele será removido. Se o cabeçalho não existir, a função não executará nenhuma ação e será concluída com êxito.

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