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

Статья
11/20/2024

Функция 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-terminated, указывающую полный путь и имя файла телефонной книги (PBK). Если этот параметр NULL, функция использует текущий файл телефонной книги по умолчанию. Файл телефонной книги по умолчанию — это файл, выбранный пользователем в разделе настройки пользователя свойств диалогового окна "Подключение к сети".

Windows Me/98/95: этот параметр всегда должен быть NULL. Подключение к сети хранит записи телефонной книги в реестре, а не в файле телефонной книги.

[in] unnamedParam2

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

[in] unnamedParam3

Задает одноуровневый индекс подзадачи.

[in, out] unnamedParam4

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

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

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

Этот параметр может быть NULL.

[in, out] unnamedParam5

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

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

Этот параметр может быть NULL, если lpRasSubEntryNULL.

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