TSPI_lineDrop, fonction (tspi.h)

Article
08/26/2023

La fonction TSPI_lineDrop supprime ou déconnecte l’appel spécifié. Les informations utilisateur-utilisateur peuvent éventuellement être transmises dans le cadre de la déconnexion de l’appel. Cette fonction peut être appelée par l’application à tout moment. Lorsque TSPI_lineDrop retourne, l’appel doit être inactif.

Syntaxe

LONG TSPIAPI TSPI_lineDrop(
  DRV_REQUESTID dwRequestID,
  HDRVCALL      hdCall,
  LPCSTR        lpsUserUserInfo,
  DWORD         dwSize
);

Paramètres

dwRequestID

Identificateur de la requête asynchrone.

hdCall

Le handle du fournisseur de services pour l’appel à supprimer. L’état d’appel de hdCall peut être n’importe quel état sauf inactif.

lpsUserUserInfo

Ce pointeur est valide uniquement si dwSize est différent de zéro. Il spécifie un pointeur vers une chaîne terminée par null contenant des informations utilisateur-utilisateur à envoyer à la partie distante dans le cadre de la déconnexion de l’appel. Ce pointeur a la valeur NULL si aucune information utilisateur ne doit être envoyée. Les informations utilisateur-utilisateur sont envoyées uniquement si elles sont prises en charge par le réseau sous-jacent (voir LINEDEVCAPS).

dwSize

Taille en octets des informations utilisateur-utilisateur dans lpsUserUserInfo. Si lpsUserUserInfo a la valeur NULL, dwSize est ignoré.

Valeur retournée

Retourne dwRequestID ou un numéro d’erreur si une erreur se produit. Le paramètre réel lResult du ASYNC_COMPLETION correspondant est égal à zéro si la fonction réussit ou un numéro d’erreur si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALCALLSTATE, LINEERR_RESOURCEUNAVAIL, LINEERR_NOMEM, LINEERR_USERUSERINFOTOOBIG, LINEERR_OPERATIONUNAVAIL.

Remarques

Le fournisseur de services retourne LINEERR_INVALCALLSTATE si l’état actuel de l’appel n’autorise pas la suppression de l’appel.

Lors de l’appel de TSPI_lineDrop, les appels connexes peuvent parfois également être affectés. Par exemple, la suppression d’une téléconférence peut supprimer tous les appels individuels participants. LINE_CALLSTATE messages sont envoyés à TAPI pour tous les appels dont l’état de l’appel est affecté. En règle générale, un appel supprimé passe à l’état inactif . L’appel de TSPI_lineDrop sur un appel dans l’état de l’offre rejette l’appel. Tous les réseaux téléphoniques n’offrent pas cette fonctionnalité.

Dans les situations où l’appel à supprimer est un appel de consultation établi lors du transfert ou de l’établissement d’une téléconférence, l’appel d’origine qui a été placé dans l’état OnHoldPending est reconnecté à et il revient généralement à l’état d’appel connecté .

TAPI a la possibilité d’envoyer des informations utilisateur-utilisateur au moment de la suppression. Même si des informations utilisateur-utilisateur peuvent être envoyées, il n’y a aucune garantie que le réseau fournira ces informations à la partie distante.

Note Dans différentes configurations de ligne pontée ou de partie lorsque plusieurs parties sont à l’appel, TSPI_lineDrop peut ne pas réellement effacer l’appel.