Share via

Função WsShutdownSessionChannel (webservices.h)

  • Artigo

Usado para sinalizar o fim das mensagens para um canal de sessão.

Sintaxe

HRESULT WsShutdownSessionChannel(
  [in]           WS_CHANNEL             *channel,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Parâmetros

[in] channel

O canal de sessão a ser desligado.

[in, optional] asyncContext

Informações sobre como invocar a função de forma assíncrona ou NULL se estiver invocando de forma síncrona.

[in, optional] error

Especifica onde informações adicionais de 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_OPERATION
 Isso será retornado se o canal não estiver no estado WS_CHANNEL_STATE_OPEN .

Comentários

Essa função indicará à parte remota que todas as mensagens foram enviadas para o canal.

A parte remota pode detectar que não há mais mensagens disponíveis no canal procurando o valor retornado WS_S_END ao receber uma mensagem. (Consulte Valores retornados dos Serviços Web do Windows.) No entanto, as mensagens também poderão ficar indisponíveis se as mensagens que não são do aplicativo forem filtradas pelo canal, conforme descrito em Visão geral da camada de canal. O desligamento da sessão pode ser diferenciado da filtragem de mensagens, mantendo o controle de se as mensagens anteriores foram recebidas. Se as mensagens anteriores foram recebidas, a sessão foi desligada.

Essa função só se aplica aos canais criados com um WS_CHANNEL_TYPE com uma sessão que dá suporte ao envio de mensagens:

O canal deve estar no estado WS_CHANNEL_STATE_OPEN .

Se essa função for bem-sucedida, o valor da propriedade WS_CHANNEL_PROPERTY_IS_SESSION_SHUT_DOWN será TRUE.

Depois que um canal de sessão for desligado, tentar enviar uma mensagem no canal ou tentar desligar o canal retornará WS_E_INVALID_OPERATION.

Chamar essa função é opcional. Quando um canal de sessão é fechado usando WsCloseChannel quando em WS_CHANNEL_STATE_OPEN, o canal é desligado automaticamente como parte do processo de fechamento.

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