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

Статья
08/26/2023

Функция lineGetAgentStatus получает состояние, связанное с агентом, по указанному адресу.

Синтаксис

LONG lineGetAgentStatusA(
  HLINE             hLine,
  DWORD             dwAddressID,
  LPLINEAGENTSTATUS lpAgentStatus
);

Параметры

hLine

Дескриптор на устройстве с открытой линией.

dwAddressID

Адрес на устройстве с открытой линией, состояние агента которого необходимо запрашивать. Идентификатор адреса постоянно связан с адресом; идентификатор остается неизменным при обновлении операционной системы.

lpAgentStatus

Указатель на структуру изменчивого размера типа LINEAGENTSTATUS. После успешного выполнения запроса эта структура заполняется сведениями о состоянии агента. Перед вызовом lineGetAgentStatus приложение должно задать член dwTotalSize этой структуры, чтобы указать объем памяти, доступный ДЛЯ TAPI для возврата сведений.

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

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

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

LINEERR_INVALADDRESSID, LINEERR_INVALLINEHANDLE, LINEERR_INVALPOINTER, LINEERR_NOMEM, LINEERR_OPERATIONFAILED, LINEERR_OPERATIONUNAVAIL, LINEERR_RESOURCEUNAVAIL, LINEERR_STRUCTURETOOSMALL LINEERR_UNINITIALIZED.

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