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

Статья
03/05/2024

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

Синтаксис

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

Параметры

[in] unnamedParam1

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

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

[in] unnamedParam2

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

[in] unnamedParam3

Задает одноуровневый индекс вложенного объекта. Если индекс соответствует существующему индексу вложенного объекта, функция изменяет свойства этого вложенного объекта. Если индекс не соответствует существующему индексу, функция создает новый вложенный объект.

[in] unnamedParam4

Указатель на структуру RASSUBENTRY , которая указывает данные для вложенного вложения.

За структурой может следовать массив строк альтернативных телефонных номеров, завершаемых значением NULL. Последняя строка завершается двумя последовательными символами NULL . Элемент dwAlternateOffset структуры RASSUBENTRY содержит смещение до первой строки.

[in] unnamedParam5

Задает размер буфера lpRasSubEntry в байтах.

[in] unnamedParam6

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

[in] unnamedParam7

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

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

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

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

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

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

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

Примечание

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

Требования

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