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

Статья
11/20/2024

Функция RasGetConnectStatus получает сведения о текущем состоянии указанного подключения удаленного доступа. Приложение может использовать этот вызов для определения завершения асинхронного вызова RasDial.

Синтаксис

DWORD RasGetConnectStatusA(
  [in]      HRASCONN         unnamedParam1,
  [in, out] LPRASCONNSTATUSA unnamedParam2
);

Параметры

[in] unnamedParam1

Указывает подключение удаленного доступа, для которого требуется получить состояние. Этот дескриптор должен быть получен из RasDial или RasEnumConnections.

[in, out] unnamedParam2

Указатель на структуру RASCONNSTATUS, которая в выходных данных получает сведения о состоянии.

Для входных данных задайте для элемента dwSize dwSize структуры значение sizeof(RASCONNSTATUS), чтобы определить версию передаваемой структуры.

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

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

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

Ценность	Значение
ERROR_NOT_ENOUGH_MEMORY	Функция не могла выделить достаточно памяти для завершения операции.

Замечания

Возвращаемое значение для RasGetConnectStatus не обязательно равно значению элемента dwError структуры RASCONNSTATUS, возвращаемой RasGetConnectStatus. Возвращаемое значение RasGetConnectStatus указывает на ошибки, возникающие во время вызова функции RasGetConnectStatus, в то время как элемент dwError указывает на ошибки, которые не позволили установить подключение.

Заметка

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

Требования

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

См. также

RASCONNSTATUS

RasDial

RasEnumConnections

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

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

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