fonction TSPI_phoneSetRing (tspi.h)

Article
08/26/2023

La fonction TSPI_phoneSetRing sonne l’appareil téléphonique ouvert spécifié à l’aide du mode d’anneau et du volume spécifiés.

Syntaxe

LONG TSPIAPI TSPI_phoneSetRing(
  DRV_REQUESTID dwRequestID,
  HDRVPHONE     hdPhone,
  DWORD         dwRingMode,
  DWORD         dwVolume
);

Paramètres

dwRequestID

Identificateur de la requête asynchrone.

hdPhone

Poignée du téléphone à exécuter.

dwRingMode

Modèle de sonnerie avec lequel sonner le téléphone. Ce paramètre doit se trouver dans la plage comprise entre zéro et la valeur du membre dwNumRingModes dans la structure PHONECAPS . Si dwNumRingModes est égal à zéro, le mode d’anneau du téléphone ne peut pas être contrôlé ; si dwNumRingModes est 1, la valeur 0 pour dwRingMode indique que le téléphone ne doit pas être exécuté (silence), et d’autres valeurs comprises entre 1 et dwNumRingModes sont des modes d’anneau valides pour l’appareil téléphonique.

dwVolume

Niveau de volume avec lequel le téléphone doit être exécuté. Il s’agit d’un nombre compris entre 0x00000000 (silence) et 0x0000FFFF (volume maximal). La granularité et la quantisation réelles des paramètres de volume dans cette plage sont spécifiques au fournisseur de services. Une valeur pour dwVolume qui est hors de la plage est limitée par TAPI à la valeur la plus proche dans la plage.

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 s’il s’agit d’un numéro d’erreur si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

PHONEERR_INVALPHONEHANDLE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALRINGMODE, PHONEERR_OPERATIONUNAVAIL, PHONEERR_NOMEM.