fonction lineHold (tapi.h)

Article
03/06/2024

La fonction lineHold met l’appel spécifié en attente.

Syntaxe

LONG lineHold(
  HCALL hCall
);

Paramètres

hCall

Gérer l’appel à mettre en attente. L’application doit être propriétaire de l’appel. L’état de l’appel de hCall doit être connecté.

Valeur retournée

Retourne un identificateur de requête positif si la fonction est terminée de manière asynchrone ou un numéro d’erreur négatif si une erreur se produit. Le paramètre dwParam2 du message LINE_REPLY correspondant est égal à zéro si la fonction réussit ou s’il s’agit d’un numéro d’erreur négatif si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL, LINEERR_NOTOWNER, LINEERR_UNINITIALIZED.

Remarques

L’appel en attente est temporairement déconnecté, ce qui permet à l’application d’utiliser l’appareil de ligne pour passer ou répondre à d’autres appels. La fonction lineHold effectue une « conservation matérielle » de l’appel spécifié (par opposition à un « appel de consultation »). Un appel en attente définitive ne peut généralement pas être transféré ou inclus dans une téléconférence, mais un appel de consultation peut le faire. Les appels de consultation sont lancés à l’aide de lineSetupTransfer, lineSetupConference ou linePrepareAddToConference.

Une fois qu’un appel a été correctement mis en attente, l’état de l’appel passe généralement à onHold. Un appel retenu est récupéré par lineUnhold. Lorsqu’un appel est en attente, l’application peut recevoir des messages LINE_CALLSTATE sur les changements d’état de l’appel retenu. Par exemple, si la partie détenue raccroche, l’état de l’appel peut passer à déconnecté.

Dans une situation de pont, une opération lineHold peut ne pas mettre en attente l’appel, car la status d’autres stations de l’appel peut régir (par exemple, tenter de « tenir » un appel lorsque d’autres stations participent n’est pas possible) ; au lieu de cela, l’appel peut simplement être remplacé par le mode LINECONNECTEDMODE_INACTIVE s’il reste connecté à d’autres stations.