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

Статья
11/20/2024

Функция RasGetEntryProperties извлекает свойства записи телефонной книги.

Синтаксис

DWORD RasGetEntryPropertiesA(
  [in]      LPCSTR      unnamedParam1,
  [in]      LPCSTR      unnamedParam2,
  [in, out] LPRASENTRYA unnamedParam3,
  [in, out] LPDWORD     unnamedParam4,
  [out]     LPBYTE      unnamedParam5,
  [in, out] LPDWORD     unnamedParam6
);

Параметры

[in] unnamedParam1

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

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

[in] unnamedParam2

Указатель на строку null-terminated, указывающую существующее имя записи. Если указана пустая строка, функция возвращает значения по умолчанию в буферах, на которые указывает lpRasEntry и lpbDeviceInfo.

[in, out] unnamedParam3

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

В выходных данных структура получает данные подключения, связанные с записью телефонной книги, указанной параметром lpszEntry.

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

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

Windows Me/98 и Windows 95 OSR2: Microsoft Layer для Юникода не поддерживает dwAlternateOffset в RASENTRY.

[in, out] unnamedParam4

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

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

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

Чтобы определить требуемый размер буфера, вызовите RasGetEntryProperties с lpRasEntry значением NULL и *lpdwEntryInfoSize равным нулю. Функция возвращает требуемый размер буфера в *lpdwEntryInfoSize.

[out] unnamedParam5

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

Windows Me/98/95: указатель на буфер, который получает сведения о конфигурации для конкретного устройства. Не управляйте этой непрозрачной информацией об устройстве TAPI напрямую. Дополнительные сведения о конфигурации устройства TAPI см. в функции lineGetDevConfig в справочнике программиста TAPI в пакете SDK для платформы.

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

[in, out] unnamedParam6

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

Windows Me/98/95: указатель на переменную, которая в входных данных указывает размер буфера, указанного параметром lpbDeviceInfo.

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

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

Чтобы определить требуемый размер буфера, вызовите RasGetEntryProperties с lpbDeviceInfo значением NULL и *lpdwDeviceInfoSize равно нулю. Функция возвращает требуемый размер буфера в *lpdwDeviceInfoSize.

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

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

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

Ценность	Значение
ERROR_INVALID_PARAMETER	Функция была вызвана недопустимым параметром.
ERROR_INVALID_SIZE	Значение члена dwSize lpRasEntry слишком мало.
ERROR_BUFFER_INVALID	Недопустимый адрес или буфер, указанный lpRasEntry.
ERROR_BUFFER_TOO_SMALL	Размер буфера, указанный в lpdwEntryInfoSize слишком мал.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Запись телефонной книги не существует, или файл телефонной книги поврежден и /или имеет отсутствующие компоненты.

Замечания

Заметка

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

Требования

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

См. также

RASENTRY

RasSetEntryProperties

Обзор службы удаленного доступа (RAS)

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

Поделиться через