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

Статья
11/20/2024

Функция RasHangUp завершает подключение к удаленному доступу. Соединение указывается с дескриптором подключения RAS. Функция освобождает все RASAPI32.DLL ресурсы, связанные с дескриптором.

Синтаксис

DWORD RasHangUpA(
  [in] HRASCONN unnamedParam1
);

Параметры

[in] unnamedParam1

Указывает подключение удаленного доступа для завершения. Это дескриптор, возвращаемый из предыдущего вызова RasDial или RasEnumConnections.

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

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

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

Ценность	Значение
ERROR_INVALID_HANDLE	Дескриптор, указанный в hrasconn, недопустим.

Замечания

Подключение завершается, даже если вызов RasDial еще не завершен.

После этого вызова дескриптор hrasconn больше не может использоваться.

Приложение не должно вызывать RasHangUp, а затем немедленно выйти. Для правильного завершения работы компьютера состояния подключения требуется время. Если система преждевременно завершает работу компьютера с состоянием, компьютер состояния может не закрыть порт должным образом, оставив порт в несогласованном состоянии. Кроме того, немедленная попытка использовать то же подключение может завершиться ошибкой, оставив подключение неиспользуемым. Простой способ избежать этих проблем заключается в вызове спящего(3000) после возвращения из RasHangUp; После этой приостановки приложение может выйти. Более быстрый способ избежать этих проблем заключается в том, что после возвращения из RasHangUpвызов RasGetConnectStatus(hrasconn) и спящего(0) в цикле, пока RasGetConnectStatus возвращает ERROR_INVALID_HANDLE.

Вы можете вызвать RasHangUp на дескриптор, возвращенный RasGetSubEntryHandle, чтобы завершить одну ссылку в подключении с несколькими ссылками. Однако в этом случае нельзя использовать RasGetConnectStatus, чтобы определить, завершается ли ссылка; RasGetConnectStatus может не возвращать ERROR_INVALID_HANDLE, даже если ссылка была успешно завершена.

Заметка

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

Требования

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