Функция RasConnectionNotificationA (ras.h)

Статья
11/20/2024

Функция RasConnectionNotification указывает объект события, который система задает сигнальное состояние при создании или завершении подключения RAS.

Синтаксис

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

Параметры

[in] unnamedParam1

Дескриптор подключения RAS, получающего уведомления. Это может быть дескриптор, возвращаемый функцией RasDial или RasEnumConnect ions. Если этот параметр INVALID_HANDLE_VALUE, уведомления получаются для всех подключений RAS на локальном клиенте.

[in] unnamedParam2

Задает дескриптор объекта события. Используйте функцию CreateEvent для создания объекта события.

[in] unnamedParam3

Указывает событие RAS, которое приводит к тому, что система сигнализирует объекту события, указанному параметром hEvent. Этот параметр представляет собой сочетание следующих значений.

Ценность	Значение
RASCN_Connection	Если hrasconn INVALID_HANDLE_VALUE, hEvent сигнализирует при создании подключения RAS.
RASCN_Disconnection	hEvent сигнализирует о завершении подключения hrasconn. Если hrasconn является многолинейным подключением, событие сигнализирует, когда все вложенные элементы отключены. Если hrasconnINVALID_HANDLE_VALUE, событие сигнализирует о завершении подключения RAS.
RASCN_BandwidthAdded	Windows NT: Если hrasconn является дескриптором в объединенном многолинейном подключении, hEvent сигнализирует при подключении подсети.
RASCN_BandwidthRemoved	Windows NT: Если hrasconn является дескриптором в объединенном многолинейном подключении, hEvent сигнализирует об отключении подзадачи.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение ERROR_SUCCESS.

Если функция завершается ошибкой, возвращаемое значение является ненулевым кодом ошибки из кодов ошибок маршрутизации и удаленного доступа или Winerror.h.

Замечания

Чтобы определить, когда объект события сигнализирует, используйте любую из функций ожидания .

Когда событие сигнализирует, используйте другие функции RAS, такие как RasEnumConnections, чтобы получить дополнительные сведения о подключении RAS, созданном или завершенном.

Заметка

Заголовок ras.h определяет RasConnectionNotification как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	ras.h
библиотеки	Rasapi32.lib
DLL	Rasapi32.dll

См. также

CreateEvent

RasEnumConnections

Обзор службы удаленного доступа (RAS)

функции службы удаленного доступа

Поделиться через