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

Статья
03/05/2024

Функция RasGetSubEntryHandle извлекает дескриптор соединения для указанного вложенного объекта многолинейного соединения.

Синтаксис

DWORD RasGetSubEntryHandleA(
  [in]  HRASCONN   unnamedParam1,
  [in]  DWORD      unnamedParam2,
  [out] LPHRASCONN unnamedParam3
);

Параметры

[in] unnamedParam1

Указывает дескриптор подключения HRASCONN , возвращаемый функцией RasDial для записи телефонной книги с несколькими ссылками.

[in] unnamedParam2

Указывает допустимый индекс вложенного входа для записи телефонной книги.

[out] unnamedParam3

Указатель на переменную HRASCONN , которая получает дескриптор соединения, представляющий соединение вложенного объекта.

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

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

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

Значение	Значение
ERROR_INVALID_HANDLE	Дескриптор подключения hRasConn не представляет запись подключенной телефонной книги.
ERROR_PORT_NOT_OPEN	Параметры hRasConn и dwSubEntry являются допустимыми, но указанный вложенный объект не подключен.
ERROR_NO_MORE_ITEMS	Значение, указанное в параметре dwSubEntry , превышает максимальное число вложенных входов для записи телефонной книги.

Дескриптор соединения, указанный в параметре hRasConn , относится ко всему многоканательной связи, но дескриптор соединения, возвращенный в параметре *lphRasConn , ссылается только на вложенное соединение. Используйте дескриптор подключения вложенного объекта в любой функции, которая принимает параметр hRasConn , включая функции RasHangUp, RasGetConnectStatus и RasGetProjectionInfoEx . Сведения о проекции, возвращаемые RasGetProjectionInfo для записи с несколькими ссылками, одинаковы для каждого дескриптора подключения вложенного объекта, как и для дескриптора подключения main.

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

Примечание

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

Требования

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