Функция lineGetDevConfig (tapi.h)

Статья
03/02/2024

Функция lineGetDevConfig возвращает "непрозрачный" объект структуры данных, содержимое которого относится к строке (поставщику услуг) и классу устройства. Объект структуры данных хранит текущую конфигурацию устройства потока мультимедиа, связанного с линейным устройством.

Синтаксис

LONG lineGetDevConfig(
  DWORD       dwDeviceID,
  LPVARSTRING lpDeviceConfig,
  LPCSTR      lpszDeviceClass
);

Параметры

dwDeviceID

Идентификатор настраиваемого линейного устройства.

lpDeviceConfig

Указатель на расположение памяти типа VARSTRING , где возвращается структура конфигурации устройства. После успешного выполнения запроса это расположение заполняется конфигурацией устройства. Член dwStringFormat в структуре VARSTRING имеет значение STRINGFORMAT_BINARY. Перед вызовом lineGetDevConfig приложение должно задать член dwTotalSize этой структуры, чтобы указать объем памяти, доступный ДЛЯ TAPI для возврата сведений.

Примечание Если параметры размера в структуре неверны, существует вероятность того, что данные могут быть перезаписаны. Дополнительные сведения о настройке размеров структуры см. в разделе о выделении памяти .

lpszDeviceClass

Указатель на строку, завершающуюся значением NULL, которая указывает класс устройства, конфигурация которого запрашивается. Допустимые строки класса устройстваGetID совпадают с строками, указанными для функции.

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

Возвращает ноль, если функция выполнена успешно, или отрицательное число ошибки, если возникает ошибка. Возможные возвращаемые значения:

LINEERR_BADDEVICEID, LINEERR_NODRIVER, LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_STRUCTURETOOSMALL, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_UNINITIALIZED LINEERR_NODEVICE.

Функцию lineGetDevConfig можно использовать для получения структуры данных из TAPI, которая указывает конфигурацию устройства потока мультимедиа, связанного с определенным линейным устройством. Например, содержимое этой структуры может указывать скорость передачи данных, формат символов, схемы модуляции и параметры протокола управления ошибками для мультимедийного устройства datamodem, связанного со строкой.

Как правило, приложение вызывает lineGetID для идентификации устройства потока мультимедиа, связанного с линией, а затем вызывает lineConfigDialog , чтобы разрешить пользователю настроить конфигурацию устройства. Затем он может вызвать lineGetDevConfig и сохранить сведения о конфигурации в телефонной книге (или другой базе данных), связанной с определенным назначением звонка. Если позже пользователь захочет снова вызвать то же назначение, можно использовать lineSetDevConfig для восстановления параметров конфигурации, выбранных пользователем. Функции lineSetDevConfig, lineConfigDialog и lineGetDevConfig можно использовать в этом порядке, чтобы позволить пользователю просматривать и обновлять параметры.

Точный формат данных, содержащихся в структуре, зависит от API потока строк и мультимедиа (класс устройства), не является документированием и не определен. Структура, возвращаемая этой функцией, не может напрямую обращаться к приложению или управляться ими, но может быть сохранена без изменений и позже использоваться в lineSetDevConfig для восстановления параметров. Структура также не может быть обязательно передана другим устройствам, даже тому же классу устройств (хотя в некоторых случаях это может работать, это не гарантируется).