Função WsRemoveHeader (webservices.h)

  • Artigo

Remove o objeto de WS_HEADER_TYPE padrão de uma mensagem.

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

Para tipos de cabeçalho definidos pelo aplicativo, use a função WsRemoveCustomHeader .

Sintaxe

HRESULT WsRemoveHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [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] headerType

Indica o tipo 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.

Retornar valor

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_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, nenhuma ação será tomada e a função será concluída com êxito.

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