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

Статья
08/25/2023

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

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

[in] unnamedParam2

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

[in, out] unnamedParam3

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

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

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

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

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

[in, out] unnamedParam4

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

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

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

Чтобы определить требуемый размер буфера, вызовите 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 , если параметр lpbDeviceInfo имеет значение NULL.

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

См. также раздел

RASENTRY

RasSetEntryProperties

Общие сведения о службе удаленного доступа (RAS)

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