Função WsAddCustomHeader (webservices.h)

Adiciona o cabeçalho definido pelo aplicativo especificado à mensagem.

Sintaxe

HRESULT WsAddCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *headerDescription,
  [in]           WS_WRITE_OPTION              writeOption,
  [in, ref]      const void                   *value,
  [in]           ULONG                        valueSize,
  [in]           ULONG                        headerAttributes,
  [in, optional] WS_ERROR                     *error
);

Parâmetros

[in] message

A mensagem à qual adicionar o cabeçalho.

A mensagem pode estar em qualquer estado, exceto WS_MESSAGE_STATE_EMPTY (consulte a enumeração WS_MESSAGE_STATE ..

[in] headerDescription

A estrutura WS_ELEMENT_DESCRIPTION que descreve o cabeçalho.

[in] writeOption

Se o elemento de cabeçalho é necessário e como o valor é alocado. Para obter mais informações, consulte a enumeração WS_WRITE_OPTION .

[in, ref] value

O valor do cabeçalho a ser serializado. Para obter mais informações, consulte a enumeração WS_WRITE_OPTION .

[in] valueSize

O tamanho do valor que está sendo serializado, em bytes.

[in] headerAttributes

Os valores dos atributos SOAP para o cabeçalho.

[in, optional] error

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

Retornar valor

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

Código de retorno	Descrição
WS_E_INVALID_FORMAT	Há várias instâncias do mesmo tipo de cabeçalho presentes na mensagem.
E_OUTOFMEMORY	Memória insuficiente para concluir a operação.
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

A função WsAddCustomHeader foi projetada para manipular tipos de cabeçalhos direcionados ao receptor final. Os cabeçalhos direcionados a outro receptor são ignorados.

Se você estiver substituindo um cabeçalho, chame a função WsRemoveCustomHeader para remover as instâncias existentes do cabeçalho antes de chamar WsAddCustomHeader.

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