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

Статья
03/05/2024

Функция lineGetIcon позволяет приложению получить значок конкретного устройства (или поставщика) строки обслуживания для отображения пользователю.

Синтаксис

LONG lineGetIcon(
  DWORD   dwDeviceID,
  LPCSTR  lpszDeviceClass,
  LPHICON lphIcon
);

Параметры

dwDeviceID

Идентификатор устройства линии, значок которого запрашивается.

lpszDeviceClass

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

lphIcon

Указатель на расположение памяти, в которое возвращается дескриптор значка.

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

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

LINEERR_BADDEVICEID, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALDEVICECLASS, LINEERR_UNINITIALIZED, LINEERR_NOMEM LINEERR_NODEVICE.

Функция lineGetIcon заставляет поставщик возвращать дескриптор (в lphIcon) ресурсу icon (полученному из LoadIcon), связанному с указанной строкой. Дескриптор значка предназначен для ресурса, связанного с поставщиком. Приложение должно использовать CopyIcon , если оно хочет ссылаться на значок после выгрузки поставщика, что маловероятно, если в приложении открыта строка.

Параметр lpszDeviceClass позволяет поставщику возвращать различные значки в зависимости от типа службы, на которую ссылается вызывающий объект. Допустимые строки такие же, как и для lineGetID. Например, если строка поддерживает API Comm, передача "COMM" как lpszDeviceClass приводит к тому, что поставщик возвращает значок, связанный с функциями устройства Comm поставщика услуг. Параметры tapi/line, "" или NULL можно использовать для запроса значка для службы линии.

Для приложений, использующих API более ранней версии, чем 2.0, если поставщик не возвращает значок (так как данный класс устройства является недопустимым или поставщик не поддерживает значки), TAPI заменяет универсальный значок устройства телефонии. Для приложений, использующих API версии 2.0 или более поздней, TAPI заменяет значок строки по умолчанию, только если параметр lpszDeviceClass имеет значение "tapi/line", "" или NULL. Для любого другого класса устройства, если данный класс устройства недопустим или поставщик не поддерживает значки для класса, функция lineGetIcon возвращает LINEERR_INVALDEVICECLASS.