Função RasConnectionNotificationA (ras.h)

  • Artigo

A função RasConnectionNotification especifica um objeto de evento que o sistema define como o estado sinalizado quando uma conexão RAS é criada ou encerrada.

Sintaxe

DWORD RasConnectionNotificationA(
  [in] HRASCONN unnamedParam1,
  [in] HANDLE   unnamedParam2,
  [in] DWORD    unnamedParam3
);

Parâmetros

[in] unnamedParam1

Um identificador para a conexão RAS que recebe as notificações. Esse pode ser um identificador retornado pela função RasDial ou RasEnumConnections . Se esse parâmetro for INVALID_HANDLE_VALUE, as notificações serão recebidas para todas as conexões RAS no cliente local.

[in] unnamedParam2

Especifica o identificador de um objeto de evento. Use a função CreateEvent para criar um objeto de evento.

[in] unnamedParam3

Especifica o evento RAS que faz com que o sistema sinalize o objeto de evento especificado pelo parâmetro hEvent . Esse parâmetro é uma combinação dos valores a seguir.

Valor Significado
RASCN_Connection
 Se hrasconn for INVALID_HANDLE_VALUE, hEvent será sinalizado quando qualquer conexão RAS for criada.
RASCN_Disconnection
 hEvent é sinalizado quando a conexão hrasconn é encerrada. Se hrasconn for uma conexão multilink, o evento será sinalizado quando todas as subentidades forem desconectadas. Se hrasconn for INVALID_HANDLE_VALUE, o evento será sinalizado quando qualquer conexão RAS for encerrada.
RASCN_BandwidthAdded
 Windows NT: se hrasconn for um identificador para uma conexão multilink combinada, hEvent será sinalizado quando uma subentidade estiver conectada.
RASCN_BandwidthRemoved
 Windows NT: se hrasconn for um identificador para uma conexão multilink combinada, hEvent será sinalizado quando uma subentidade for desconectada.

Retornar valor

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado será um código de erro diferente de zero de Códigos de Erro de Roteamento e Acesso Remoto ou Winerror.h.

Comentários

Para determinar quando o objeto de evento é sinalizado, use qualquer uma das funções de espera.

Quando o evento for sinalizado, use outras funções RAS, como RasEnumConnections, para obter mais informações sobre a conexão RAS que foi criada ou encerrada.

Observação

O cabeçalho ras.h define RasConnectionNotification como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho ras.h
Biblioteca Rasapi32.lib
DLL Rasapi32.dll

Confira também

CreateEvent

Rasenumconnections

Visão geral do RAS (Serviço de Acesso Remoto)

Funções do serviço de acesso remoto