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

Статья
08/25/2023

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

Синтаксис

DWORD RasGetSubEntryPropertiesA(
  [in]      LPCSTR         unnamedParam1,
  [in]      LPCSTR         unnamedParam2,
  [in]      DWORD          unnamedParam3,
  [in, out] LPRASSUBENTRYA unnamedParam4,
  [in, out] LPDWORD        unnamedParam5,
  [in]      LPBYTE         unnamedParam6,
  [in]      LPDWORD        unnamedParam7
);

Параметры

[in] unnamedParam1

Указатель на строку, завершающуюся значением NULL, которая указывает полный путь и имя файла телефонной книги (PBK). Если этот параметр имеет значение NULL, функция использует текущий файл телефонной книги по умолчанию. Файл телефонной книги по умолчанию — это файл, выбранный пользователем на странице свойств Пользовательские настройки диалогового окна Сеть удаленного доступа.

Windows Me/98/95: Этот параметр всегда должен иметь значение NULL. Коммутируемая сеть сохраняет записи телефонной книги в реестре, а не в файле телефонной книги.

[in] unnamedParam2

Указатель на строку, завершающуюся null, которая указывает имя существующей записи в телефонной книге.

[in] unnamedParam3

Задает одноуровневый индекс вложенного объекта.

[in, out] unnamedParam4

Указатель на структуру RASSUBENTRY , за которой следуют дополнительные байты для альтернативного списка номеров телефонов, если таковой имеется.

В выходных данных структура получает сведения об указанном вложенном объекте.

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

Этот параметр может принимать значение NULL.

[in, out] unnamedParam5

Указатель на переменную, указывающую на входные данные размер буфера lpRasSubEntry в байтах .

В выходных данных переменная получает количество возвращаемых байтов или требуемое количество байтов, если буфер слишком мал.

Этот параметр может иметь значение NULL, если lpRasSubEntry имеет значение NULL.

[in] unnamedParam6

Указатель на блок конфигурации устройства TAPI. Этот параметр в настоящее время не используется. Вызывающий объект должен передать значение NULL для этого параметра. Дополнительные сведения о блоках конфигурации устройств TAPI см. в функции lineGetDevConfig.

[in] unnamedParam7

Указатель на DWORD , указывающий размер блока конфигурации устройства TAPI. Этот параметр в настоящее время не используется. Вызывающий объект должен передать значение NULL для этого параметра.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Функция была вызвана с недопустимым параметром.
ERROR_BUFFER_INVALID	Недопустимый адрес или буфер, указанный в lpRasSubEntry .
ERROR_BUFFER_TOO_SMALL	Буфер lpRasSubEntry слишком мал. Переменная lpdwcb получает требуемый размер буфера.
ERROR_CANNOT_OPEN_PHONEBOOK	Телефонная книга повреждена или в ней отсутствуют компоненты.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Запись телефонной книги не существует.

Запись телефонной книги RAS может содержать ноль или более вложенных входов, каждый из которых минимально состоит из устройства и номера телефона. Запись телефонной книги с несколькими вложенными входами можно настроить для набора первого доступного или всех вложенных входов при наборе.

Используйте функцию RasGetEntryProperties , чтобы получить структуру RASENTRY, содержащую сведения о вложенных объектах телефонной книги. Элемент dwSubEntries указывает количество вложенных элементов, а элемент dwDialMode — конфигурацию набора номера.

Примечание

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

Требования

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