Función lineGetAppPriority (tapi.h)

Artículo
03/05/2024

La función lineGetAppPriority permite a una aplicación determinar si está o no en la lista de prioridad de entrega para un modo multimedia determinado o el modo de solicitud de telefonía asistida y, si es así, su posición en la lista de prioridades.

Sintaxis

LONG lineGetAppPriority(
  LPCSTR            lpszAppFilename,
  DWORD             dwMediaMode,
  LPLINEEXTENSIONID lpExtensionID,
  DWORD             dwRequestMode,
  LPVARSTRING       lpExtensionName,
  LPDWORD           lpdwPriority
);

Parámetros

lpszAppFilename

Puntero a una cadena que contiene el nombre del archivo del módulo ejecutable de la aplicación, sin datos de directorio. En la versión 2.0 o posterior de la API, el parámetro puede estar en formato de nombre de archivo largo, del que el formato de nombre de archivo 8.3 es un subconjunto adecuado. Los nombres de archivo largos, a diferencia de los nombres de archivo 8.3, se conservan mayúsculas de minúsculas. Ninguno de los formatos de nombre de archivo distingue mayúsculas de minúsculas. Para obtener más información, vea Convenciones de nombre de archivo. En las versiones de API anteriores a 2.0, el parámetro debe especificar un nombre de archivo en el formato 8.3; No se pueden usar nombres de archivo largos.

dwMediaMode

Modo multimedia para el que se van a obtener los datos de prioridad. El valor puede ser una de las LINEMEDIAMODE_ Constantes; solo puede estar activado un solo bit. El valor 0 debe usarse si se comprueba la prioridad de la aplicación para las solicitudes de telefonía asistida.

lpExtensionID

Puntero a la estructura del tipo LINEEXTENSIONID. Este parámetro se ignora.

dwRequestMode

Las condiciones de este parámetro son, si el parámetro dwMediaMode es cero, este parámetro especifica el modo de solicitud de telefonía asistida para el que se comprobará la prioridad. Debe ser LINEREQUESTMODE_MAKECALL. Este parámetro se omite si dwMediaMode no es cero.

lpExtensionName

Este parámetro se ignora.

lpdwPriority

Puntero a una ubicación de memoria de tamaño DWORD en la que TAPI escribe la prioridad de la aplicación para el modo de solicitud o medios especificado. El valor 0 se devuelve si la aplicación no está en la lista de prioridad almacenada y actualmente no tiene ningún dispositivo de línea abierto con la propiedad solicitada del modo multimedia especificado o si se ha registrado para el modo de solicitud especificado.

En las versiones de API anteriores a 2.0, se devuelve el valor –1 (0xFFFFFFFF) si la aplicación tiene la línea abierta para el modo multimedia especificado o se ha registrado para las solicitudes especificadas, pero la aplicación no está en la lista de prioridades almacenadas; es decir, solo se encuentra en la lista de prioridades temporales. En la versión de API 2.0 o posterior, se devuelve el valor 0 para indicar esta condición.

De lo contrario, el valor indica la posición de la aplicación en la lista; 1 siendo la prioridad más alta y aumentando los valores que indican la disminución de la prioridad.

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_INIFILECORRUPT, LINEERR_INVALREQUESTMODE, LINEERR_INVALAPPNAME, LINEERR_NOMEM, LINEERR_INVALMEDIAMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL.

Comentarios

Si se devuelve LINEERR_INVALMEDIAMODE, el valor especificado en dwMediaMode no es cero, no es un modo multimedia extendido válido y no una de las constantes de LINEMEDIAMODE_ o más de un bit está activado en el valor del parámetro.