Compartilhar via

Função WsAddMappedHeader (webservices.h)

  • Artigo

Adiciona um cabeçalho mapeado especificado à mensagem.

Sintaxe

HRESULT WsAddMappedHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           WS_TYPE             valueType,
  [in]           WS_WRITE_OPTION     writeOption,
  [in]           const void          *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Parâmetros

[in] message

Ponteiro para uma estrutura WS_MESSAGE que representa a mensagem à qual adicionar o cabeçalho mapeado.

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

[in] headerName

Ponteiro para um WS_XML_STRING que contém o nome do cabeçalho.

[in] valueType

O tipo de valor de cabeçalho a ser desserializado. Para tipos possíveis e os cabeçalhos correspondentes, consulte o WS_HEADER_TYPE

[in] writeOption

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

[in] 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, optional] error

Ponteiro para uma estrutura de 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 retorna um código de erro HRESULT.

Código de retorno Descrição
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

Uma mensagem pode conter informações adicionais específicas do transporte que não fazem parte do envelope de mensagem. Essas informações específicas do transporte podem ser expostas programaticamente como cabeçalhos da mensagem. A função WsAddMappedHeader é usada para adicionar esse cabeçalho que será mapeado em algum local específico do transporte.

Ao usar o canal HTTP, você deve especificar os mapeamentos necessários antes de chamar essa função para adicionar os cabeçalhos. Para obter mais informações, consulte WS_HTTP_MESSAGE_MAPPING.

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

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