Função WsSendReplyMessage (webservices.h)

  • Artigo

Envia uma mensagem que é uma resposta a uma mensagem recebida.

Sintaxe

HRESULT WsSendReplyMessage(
  [in]           WS_CHANNEL                   *channel,
  [in]           WS_MESSAGE                   *replyMessage,
  [in]           const WS_MESSAGE_DESCRIPTION *replyMessageDescription,
  [in]           WS_WRITE_OPTION              writeOption,
                 const void                   *replyBodyValue,
  [in]           ULONG                        replyBodyValueSize,
  [in]           WS_MESSAGE                   *requestMessage,
  [in, optional] const WS_ASYNC_CONTEXT       *asyncContext,
  [in, optional] WS_ERROR                     *error
);

Parâmetros

[in] channel

Um ponteiro para o objeto Channel no qual enviar a mensagem de resposta. O ponteiro deve referenciar um objeto WS_CHANNEL válido.

[in] replyMessage

Um ponteiro para o objeto Message para enviar a resposta. O ponteiro deve referenciar um objeto WS_MESSAGE válido.

O estado do objeto message deve ser definido como WS_MESSAGE_STATE_EMPTY ou WS_MESSAGE_STATE_INITIALIZED.

Nota Se uma mensagem inicializada for fornecida, ela deverá ser inicializada usando WS_REPLY_MESSAGE ou WS_FAULT_MESSAGE.
 

[in] replyMessageDescription

Um ponteiro para um objeto WS_MESSAGE_DESCRIPTION . O campo de ação de WS_MESSAGE_DESCRIPTION é usado como o cabeçalho de ação para a mensagem de resposta. Esse campo poderá ser NULL se nenhuma ação for necessária.

O campo bodyElementDescription do WS_MESSAGE_DESCRIPTION é usado para serializar o corpo da mensagem de resposta. Esse campo poderá ser NULL se nenhum elemento de corpo for desejado. Consulte WsWriteBody para obter informações sobre como o bodyElementDescription é usado para serializar um valor.

[in] writeOption

Determina se o elemento body é necessário e como o valor é alocado.

Consulte WS_WRITE_OPTION para obter mais informações.

replyBodyValue

Um ponteiro nulo para o valor a ser serializado na mensagem de resposta.

[in] replyBodyValueSize

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

[in] requestMessage

Um ponteiro para um objeto WS_MESSAGE encapsulando o texto da mensagem de solicitação. Isso é usado para obter informações de correlação usadas na formulação da mensagem de resposta.

Nota A mensagem pode estar em qualquer estado, exceto WS_MESSAGE_STATE_EMPTY.
 

[in, optional] asyncContext

Um ponteiro para um WS_ASYNC_CONTEXT estrutura de dados com informações sobre como invocar a função de forma assíncrona. Um valor NULL indica uma solicitação de operação síncrona.

[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_S_ASYNC
 A operação assíncrona ainda está pendente.
WS_E_OPERATION_ABORTED
 A operação foi anulada.
WS_E_INVALID_OPERATION
 A operação não é permitida devido ao estado atual do objeto.
WS_E_ENDPOINT_DISCONNECTED
 A conexão com o ponto de extremidade remoto foi encerrada.
WS_E_INVALID_FORMAT
 Os dados de entrada não estavam no formato esperado ou não tinham o valor esperado.
WS_E_OPERATION_TIMED_OUT
 A operação não foi concluída dentro do tempo alocado.
WS_E_QUOTA_EXCEEDED
 Uma cota foi excedida.
WS_E_SECURITY_VERIFICATION_FAILURE
 A verificação de segurança não foi bem-sucedida para os dados recebidos.
WS_E_SECURITY_SYSTEM_FAILURE
 Falha na operação de segurança na estrutura dos Serviços Web do Windows.
WS_E_SECURITY_TOKEN_EXPIRED
 Um token de segurança foi rejeitado pelo servidor porque expirou.
E_OUTOFMEMORY
 Ficou sem memória.
E_INVALIDARG
 Um ou mais argumentos são inválidos.
Outros erros
Essa função pode retornar outros erros não listados acima.

Comentários

A mensagem de resposta incluirá informações de correlação conforme apropriado para o WS_ADDRESSING_VERSION. Consulte Visão geral da camada de canal para obter mais informações sobre como correlacionar mensagens de resposta de solicitação.

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