Função WsSetHeader (webservices.h)

  • Artigo

Adiciona ou substitui o cabeçalho padrão especificado na mensagem.

Sintaxe

HRESULT WsSetHeader(
  [in]           WS_MESSAGE      *message,
  [in]           WS_HEADER_TYPE  headerType,
  [in]           WS_TYPE         valueType,
  [in]           WS_WRITE_OPTION writeOption,
                 const void      *value,
  [in]           ULONG           valueSize,
  [in, optional] WS_ERROR        *error
);

Parâmetros

[in] message

A mensagem na qual definir o cabeçalho.

A mensagem pode estar em qualquer estado , mas WS_MESSAGE_STATE_EMPTY.

[in] headerType

O tipo de cabeçalho a ser serializado.

[in] valueType

O tipo de valor a serializar. Consulte WS_HEADER_TYPE para obter o conjunto de tipos com suporte para cada tipo de cabeçalho.

[in] writeOption

Se o elemento de cabeçalho é necessário e como o valor é alocado. WS_WRITE_NILLABLE_VALUE e WS_WRITE_NILLABLE_POINTER opções de gravação não podem ser especificadas, pois os tipos de cabeçalho em WS_HEADER_TYPE não podem ser anuláveis nas respectivas especificações de padrões. Consulte WS_WRITE_OPTION para obter mais informações.

value

O valor do cabeçalho a ser serializado. Consulte WS_WRITE_OPTION para obter mais informações.

[in] valueSize

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

[in, optional] error

Especifica onde informações adicionais de 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

Essa API permite a configuração de tipos de cabeçalho padrão (consulte WS_HEADER_TYPE). Para tipos de cabeçalho definidos pelo aplicativo, use WsAddCustomHeader.

Essa API foi projetada para manipular tipos de cabeçalhos que aparecem uma vez na mensagem e são direcionados para o receptor final. Cabeçalhos direcionados com uma função/ator que não seja o receptor final são ignorados por essa API.

Se um cabeçalho do tipo fornecido (direcionado ao receptor final) já existir na mensagem, ele será substituído.

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