lineGetAppPriorityW, fonction (tapi.h)

La fonction lineGetAppPriority permet à une application de déterminer s’il se trouve 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 de priorité.

Syntaxe

LONG lineGetAppPriorityW(
  LPCWSTR           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 conservés dans la casse. Aucun format 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 à la version 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 n’est pas zéro.

lpExtensionName

Ce paramètre est ignoré.

lpdwPriority

Pointeur vers un pointeur DWORDemplacement de mémoire de taille 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 n’est 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 ayant inscrit pour le mode de requête spécifié.

Dans les versions d’API antérieures à la version 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 n’est pas dans la liste de priorité stockée ; autrement dit, il se trouve dans la liste de priorité temporaire uniquement. Dans 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 augmentant les valeurs indiquant une priorité décroissante.

Valeur de retour

Retourne zéro si la requête réussit ou si un numéro d’erreur négatif 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 non l’une des constantes LINEMEDIAMODE_, ou plusieurs bits sont activées dans la valeur du paramètre.

Note

L’en-tête tapi.h définit lineGetAppPriority comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
plateforme cible	Windows
d’en-tête	tapi.h
bibliothèque	Tapi32.lib
DLL	Tapi32.dll

Voir aussi

LINEEXTENSIONID

fonctions de service de ligne supplémentaires

vue d’ensemble des informations de référence sur TAPI 2.2

VARSTRING