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

Статья
11/20/2024

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

Дополнительные сведения о телефонном интерфейсе и интерфейсе программирования приложений телефонии (TAPI) см. в части TAPI пакета СРЕДСТВ разработки программного обеспечения платформы (SDK).

Синтаксис

DWORD RasGetCountryInfoA(
  [in, out] LPRASCTRYINFOA unnamedParam1,
  [in, out] LPDWORD        unnamedParam2
);

Параметры

[in, out] unnamedParam1

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

Для входных данных задайте dwSize член структуры на sizeof(RASCTRYINFO), чтобы определить версию структуры. Кроме того, задайте для члена dwCountryId идентификатор страны или региона TAPI страны или региона, для которого нужно получить информацию.

Выделите по крайней мере 256 байт для буфера.

[in, out] unnamedParam2

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

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

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

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

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

Ценность	Значение
ERROR_INVALID_USER_BUFFER	Недопустимый адрес или буфер, указанный lpRasCtryInfo.
ERROR_INVALID_PARAMETER	Элемент dwCountryId структуры, на который указывает lpRasCtryInfo, не является допустимым значением.
ERROR_BUFFER_TOO_SMALL	Размер буфера lpRasCtryInfo, указанного параметром lpdwSize, недостаточно велик, чтобы сохранить сведения для страны или региона, определяемого элементом dwCountryId. Функция возвращает требуемый размер буфера в переменной, на которую указывает lpdwSize.
ERROR_TAPI_CONFIGURATION	Сведения о подсистеме TAPI повреждены.

Замечания

Чтобы перечислить сведения для всех стран или регионов в списке телефонии Windows, задайте dwCountryId член структуры RASCTRYINFO значение 1 в первоначальном вызове RasGetCountryInfo. Это приводит к возврату сведений о первой стране или регионе в списке. Значение, возвращаемое в элементе dwNextCountryID, является идентификатором страны или региона следующей страны или региона в списке. Используйте это значение в повторяющихся вызовах RasGetCountryInfo, пока dwNextCountryID возвращает ноль, указывая последнюю страну или регион в списке.

Заметка

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

Требования

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

См. также

RASCTRYINFO

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

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

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