Función lineGetIconA (tapi.h)

La función lineGetIcon permite a una aplicación recuperar un icono específico del dispositivo de línea de servicio (o específico del proveedor) para mostrarlo al usuario.

Sintaxis

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

Parámetros

dwDeviceID

Identificador del dispositivo de línea cuyo icono se solicita.

lpszDeviceClass

Puntero a un cadena terminada en nullque identifica un nombre de clase de dispositivo. Esta clase de dispositivo permite a la aplicación seleccionar un subicono específico aplicable a esa clase de dispositivo. Este parámetro es opcional y se puede dejar NULL o vacío, en cuyo caso se seleccionaría el icono de nivel más alto asociado al dispositivo de línea en lugar de un dispositivo de secuencia multimedia especificado.

lphIcon

Puntero a una ubicación de memoria en la que se devuelve el identificador al icono.

Valor devuelto

Devuelve cero si la solicitud se realiza correctamente o un número de error negativo si se produce un error. Los valores devueltos posibles son:

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

Observaciones

La función lineGetIcon hace que el proveedor devuelva un identificador (en lphIcon) a un recurso de icono (obtenido de LoadIcon) asociado a la línea especificada. El identificador de icono es para un recurso asociado al proveedor. La aplicación debe usar copyIcon si quiere hacer referencia al icono después de descargar el proveedor, lo que es poco probable que ocurra siempre que la aplicación tenga abierta la línea.

El parámetro lpszDeviceClass permite al proveedor devolver iconos diferentes en función del tipo de servicio al que hace referencia el autor de la llamada. Las cadenas permitidas son las mismas que para lineGetID. Por ejemplo, si la línea admite comm API, pasar "COMM" como lpszDeviceClass hace que el proveedor devuelva un icono relacionado específicamente con las funciones de dispositivo Comm del proveedor de servicios. Los parámetros "tapi/line", "" o NULL se pueden usar para solicitar el icono del servicio de línea.

En el caso de las aplicaciones que usan una versión de API anterior a la 2.0, si el proveedor no devuelve un icono (ya sea porque la clase de dispositivo especificada no es válida o el proveedor no admite iconos), TAPI sustituye un icono genérico de dispositivo de línea de telefonía. En el caso de las aplicaciones que usan la versión 2.0 o posterior de la API, TAPI sustituye el icono de línea predeterminado solo si el parámetro lpszDeviceClass es "tapi/line", "" o NULL. Para cualquier otra clase de dispositivo, si la clase de dispositivo especificada no es válida o el proveedor no admite iconos para la clase, lineGetIcon devuelve LINEERR_INVALDEVICECLASS.

Nota

El encabezado tapi.h define lineGetIcon como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de la plataforma de destino de	Windows
encabezado de	tapi.h
biblioteca de	Tapi32.lib
DLL de	Tapi32.dll

Consulte también

referencia de servicios de telefonía básica de

de información general de referencia de TAPI 2.2

lineGetID