fonction lineSetAppPriority (tapi.h)

Article
03/02/2024

La fonction lineSetAppPriority permet à une application de définir sa priorité dans la liste des priorités de transfert pour un type de média ou un mode de demande de téléphonie assistée particulier, ou de se supprimer de la liste de priorités.

Syntaxe

LONG lineSetAppPriority(
  LPCSTR            lpszAppFilename,
  DWORD             dwMediaMode,
  LPLINEEXTENSIONID lpExtensionID,
  DWORD             dwRequestMode,
  LPCSTR            lpszExtensionName,
  DWORD             dwPriority
);

Paramètres

lpszAppFilename

Pointeur vers une chaîne qui contient le nom de fichier du module exécutable d’application, sans les données du répertoire. Dans TAPI version 2.0 ou ultérieure, le paramètre peut spécifier un nom de fichier au format long ou 8.3.

dwMediaMode

Type de média pour lequel la priorité de l’application doit être définie. La valeur peut être une ou plusieurs constantes LINEMEDIAMODE . La valeur zéro doit être utilisée pour définir la priorité de l’application pour les demandes de téléphonie assistée.

lpExtensionID

Pointeur vers une 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 définie. Il doit être LINEREQUESTMODE_MAKECALL. Ce paramètre est ignoré si dwMediaMode est différent de zéro.

lpszExtensionName

Ce paramètre est ignoré.

dwPriority

Paramètre qui indique une nouvelle priorité pour l’application. Si la valeur 0 est passée, l’application est supprimée de la liste de priorités pour le média ou le mode de requête spécifié ; si elle n’était pas déjà présente, aucune erreur n’est générée. Si la valeur 1 est transmise, l’application est insérée en tant qu’application de priorité la plus élevée pour le mode média ou demande ; il est supprimé d’une position de priorité inférieure, s’il est déjà dans la liste. Toute autre valeur génère une erreur.

Valeur retournée

Retourne zéro si la requête réussit ou un numéro 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_INVALPARAM, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPOINTER.

Remarques

Si LINEERR_INVALMEDIAMODE est retourné, la valeur spécifiée dans dwMediaMode n’est pas zéro ni l’une des constantes LINEMEDIAMODE_.

Cette fonction met à jour la liste des priorités stockées. Si le système de téléphonie est initialisé, il définit également les priorités actives actuelles pour les applications en cours d’exécution ; la nouvelle priorité est utilisée lors de l’appel entrant ou de la ligneHandoff suivant en fonction du type de média.

Les priorités définies avec lineSetAppPriority sont conservées entre les redémarrages du système ou les redémarrages de tapisrv. La fonction lineOpen ouvre la ligne sans priorité d’appel spécifiée. Par défaut, l’application de priorité la plus élevée est celle qui a d’abord appelé lineOpen.