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

  • Статья

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

Синтаксис

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

Параметры

[in] unnamedParam1

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

[in, out] unnamedParam2

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

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

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

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

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

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

Комментарии

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

Примечание

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

Требования

Требование Значение
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header ras.h
Библиотека Rasapi32.lib
DLL Rasapi32.dll

См. также раздел

RASCONNSTATUS

Rasdial

RasEnumConnections

Общие сведения о службе удаленного доступа (RAS)

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