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

Статья
11/20/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 для записи с несколькими ссылками, совпадают с каждым из дескрипторов подключения, как и для основного дескриптора подключения.

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

Заметка

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

Требования

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