fonction lineGetAppPriority (tapi.h)

Article
08/26/2023

La fonction lineGetAppPriority permet à une application de déterminer si elle figure ou non dans la liste des priorités de transfert pour un mode multimédia particulier ou un mode de demande de téléphonie assistée et, le cas échéant, sa position dans la liste des priorités.

Syntaxe

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

Paramètres

lpszAppFilename

Pointeur vers une chaîne qui contient le nom du fichier de module exécutable de l’application, sans données de répertoire. Dans l’API version 2.0 ou ultérieure, le paramètre peut être au format de nom de fichier long, dont le format de nom de fichier 8.3 est un sous-ensemble approprié. Les noms de fichiers longs, contrairement aux noms de fichiers 8.3, sont de conservation de la casse. Aucun des formats de nom de fichier ne respecte la casse. Pour plus d’informations, consultez Conventions de nom de fichier. Dans les versions d’API antérieures à 2.0, le paramètre doit spécifier un nom de fichier au format 8.3 ; les noms de fichiers longs ne peuvent pas être utilisés.

dwMediaMode

Mode multimédia pour lequel les données de priorité doivent être obtenues. La valeur peut être l’une des constantes LINEMEDIAMODE_ ; un seul bit peut être activé. La valeur 0 doit être utilisée si vous vérifiez la priorité de l’application pour les demandes de téléphonie assistée.

lpExtensionID

Pointeur vers la structure de type LINEEXTENSIONID. Ce paramètre est ignoré.

dwRequestMode

Les conditions de ce paramètre sont, si le paramètre dwMediaMode est égal à zéro, ce paramètre spécifie le mode de demande de téléphonie assistée pour lequel la priorité doit être vérifiée. Il doit être LINEREQUESTMODE_MAKECALL. Ce paramètre est ignoré si dwMediaMode est différent de zéro.

lpExtensionName

Ce paramètre est ignoré.

lpdwPriority

Pointeur vers un emplacement de mémoire de taille DWORD dans lequel TAPI écrit la priorité de l’application pour le média ou le mode de requête spécifié. La valeur 0 est retournée si l’application ne figure pas dans la liste de priorité stockée et n’a actuellement aucun appareil de ligne ouvert avec la propriété demandée du mode multimédia spécifié ou s’il est inscrit pour le mode de requête spécifié.

Dans les versions d’API antérieures à 2.0, la valeur –1 (0xFFFFFFFF) est retournée si l’application a la ligne ouverte pour le mode multimédia spécifié ou s’est inscrite pour les demandes spécifiées, mais que l’application ne figure pas dans la liste des priorités stockées ; c’est-à-dire qu’il se trouve dans la liste des priorités temporaires uniquement. Dans l’API version 2.0 ou ultérieure, la valeur 0 est retournée pour indiquer cette condition.

Sinon, la valeur indique la position de l’application dans la liste ; 1 étant la priorité la plus élevée et les valeurs croissantes indiquant une priorité décroissante.

Valeur retournée

Retourne zéro si la demande réussit ou un nombre d’erreur négatif si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

LINEERR_INIFILECORRUPT, LINEERR_INVALREQUESTMODE, LINEERR_INVALAPPNAME, LINEERR_NOMEM, LINEERR_INVALMEDIAMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL.

Remarques

Si LINEERR_INVALMEDIAMODE est retourné, la valeur spécifiée dans dwMediaMode n’est pas zéro, pas un mode multimédia étendu valide et pas l’une des constantes LINEMEDIAMODE_, ou plusieurs bits sont activés dans la valeur de paramètre.