Partager via


Structure LINECALLINFO (tapi.h)

La structure LINECALLINFO contient des informations sur un appel. Ces informations restent relativement fixes pendant la durée de l’appel. Plusieurs fonctions utilisent LINECALLINFO. La structure est retournée par la fonction lineGetCallInfo et la fonction TSPI_lineGetCallInfo . Si une partie de la structure change, un message LINE_CALLINFO est envoyé à l’application indiquant l’élément d’informations qui a changé.

Les informations de modification dynamique d’un appel, telles que la progression de l’appel status, sont disponibles dans la structure LINECALLSTATUS, retournée par un appel à la fonction lineGetCallStatus.

Syntaxe

typedef struct linecallinfo_tag {
  DWORD          dwTotalSize;
  DWORD          dwNeededSize;
  DWORD          dwUsedSize;
  HLINE          hLine;
  DWORD          dwLineDeviceID;
  DWORD          dwAddressID;
  DWORD          dwBearerMode;
  DWORD          dwRate;
  DWORD          dwMediaMode;
  DWORD          dwAppSpecific;
  DWORD          dwCallID;
  DWORD          dwRelatedCallID;
  DWORD          dwCallParamFlags;
  DWORD          dwCallStates;
  DWORD          dwMonitorDigitModes;
  DWORD          dwMonitorMediaModes;
  LINEDIALPARAMS DialParams;
  DWORD          dwOrigin;
  DWORD          dwReason;
  DWORD          dwCompletionID;
  DWORD          dwNumOwners;
  DWORD          dwNumMonitors;
  DWORD          dwCountryCode;
  DWORD          dwTrunk;
  DWORD          dwCallerIDFlags;
  DWORD          dwCallerIDSize;
  DWORD          dwCallerIDOffset;
  DWORD          dwCallerIDNameSize;
  DWORD          dwCallerIDNameOffset;
  DWORD          dwCalledIDFlags;
  DWORD          dwCalledIDSize;
  DWORD          dwCalledIDOffset;
  DWORD          dwCalledIDNameSize;
  DWORD          dwCalledIDNameOffset;
  DWORD          dwConnectedIDFlags;
  DWORD          dwConnectedIDSize;
  DWORD          dwConnectedIDOffset;
  DWORD          dwConnectedIDNameSize;
  DWORD          dwConnectedIDNameOffset;
  DWORD          dwRedirectionIDFlags;
  DWORD          dwRedirectionIDSize;
  DWORD          dwRedirectionIDOffset;
  DWORD          dwRedirectionIDNameSize;
  DWORD          dwRedirectionIDNameOffset;
  DWORD          dwRedirectingIDFlags;
  DWORD          dwRedirectingIDSize;
  DWORD          dwRedirectingIDOffset;
  DWORD          dwRedirectingIDNameSize;
  DWORD          dwRedirectingIDNameOffset;
  DWORD          dwAppNameSize;
  DWORD          dwAppNameOffset;
  DWORD          dwDisplayableAddressSize;
  DWORD          dwDisplayableAddressOffset;
  DWORD          dwCalledPartySize;
  DWORD          dwCalledPartyOffset;
  DWORD          dwCommentSize;
  DWORD          dwCommentOffset;
  DWORD          dwDisplaySize;
  DWORD          dwDisplayOffset;
  DWORD          dwUserUserInfoSize;
  DWORD          dwUserUserInfoOffset;
  DWORD          dwHighLevelCompSize;
  DWORD          dwHighLevelCompOffset;
  DWORD          dwLowLevelCompSize;
  DWORD          dwLowLevelCompOffset;
  DWORD          dwChargingInfoSize;
  DWORD          dwChargingInfoOffset;
  DWORD          dwTerminalModesSize;
  DWORD          dwTerminalModesOffset;
  DWORD          dwDevSpecificSize;
  DWORD          dwDevSpecificOffset;
  DWORD          dwCallTreatment;
  DWORD          dwCallDataSize;
  DWORD          dwCallDataOffset;
  DWORD          dwSendingFlowspecSize;
  DWORD          dwSendingFlowspecOffset;
  DWORD          dwReceivingFlowspecSize;
  DWORD          dwReceivingFlowspecOffset;
  DWORD          dwCallerIDAddressType;
  DWORD          dwCalledIDAddressType;
  DWORD          dwConnectedIDAddressType;
  DWORD          dwRedirectionIDAddressType;
  DWORD          dwRedirectingIDAddressType;
} LINECALLINFO, *LPLINECALLINFO;

Membres

dwTotalSize

Taille totale allouée à cette structure de données, en octets.

dwNeededSize

Taille de cette structure de données nécessaire pour contenir toutes les informations retournées, en octets.

dwUsedSize

Taille de la partie de cette structure de données qui contient des informations utiles, en octets.

hLine

Gérez l’appareil de ligne auquel cet appel est associé.

dwLineDeviceID

Identificateur d’appareil de l’appareil de ligne auquel cet appel est associé.

dwAddressID

Identificateur d’adresse de l’adresse sur la ligne sur laquelle cet appel existe. Un identificateur d’adresse est associé de façon permanente à une adresse ; l’identificateur reste constant entre les mises à niveau du système d’exploitation.

dwBearerMode

Mode porteur actuel de l’appel. Ce membre utilise l’une des constantes LINEBEARERMODE_.

dwRate

Débit du flux de données de l’appel, en bps (bits par seconde).

dwMediaMode

Type de média du flux d’informations actuellement sur l’appel. Il s’agit du type de média déterminé par le propriétaire de l’appel, qui n’est pas nécessairement identique à celui du dernier LINE_MONITORMEDIA message. Ce membre n’est pas directement affecté par les messages LINE_MONITORMEDIA. Ce membre utilise les constantes LINEMEDIAMODE_.

dwAppSpecific

Non interprété par l’implémentation de l’API et le fournisseur de services. Il peut être défini par n’importe quelle application propriétaire de cet appel avec la fonction lineSetAppSpecific .

dwCallID

Dans certains environnements de téléphonie, le commutateur ou le fournisseur de services peut affecter un identificateur unique à chaque appel. Cela permet de suivre l’appel entre les transferts, les transferts ou d’autres événements. Le domaine de ces ID d’appel et leur étendue sont définis par le fournisseur de services. Le membre dwCallID met cet identificateur unique à la disposition des applications.

dwRelatedCallID

Les environnements de téléphonie qui utilisent souvent l’ID d’appel peuvent trouver nécessaire de lier un appel à un autre. Le membre dwRelatedCallID peut être utilisé par le fournisseur de services à cette fin.

dwCallParamFlags

Collection de paramètres liés à l’appel lorsque l’appel est sortant. Il s’agit des mêmes paramètres d’appel spécifiés dans lineMakeCall, une ou plusieurs constantes LINECALLPARAMFLAGS_.

dwCallStates

Une ou plusieurs constantes LINECALLSTATE_, qui indique les états dans lesquels l’application peut être avertie lors de cet appel. Le membre dwCallStates est constant dans LINECALLINFO et ne change pas en fonction de l’état de l’appel.

dwMonitorDigitModes

Différents modes de chiffres. Ce membre est une ou plusieurs des constantes LINEDIGITMODE_, pour lesquelles la surveillance est actuellement activée.

dwMonitorMediaModes

Différents types de médias pour lesquels la supervision est actuellement activée. Ce membre est une ou plusieurs constantes LINEMEDIAMODE_.

DialParams

Paramètres de numérotation actuellement en vigueur sur l’appel, de type LINEDIALPARAMS. À moins que ces paramètres ne soient définis par lineMakeCall ou lineSetCallParams, leurs valeurs sont identiques aux valeurs par défaut utilisées dans la structure LINEDEVCAPS .

dwOrigin

Identifie l’origine de l’appel. Ce membre peut être l’une des constantes LINECALLORIGIN_.

dwReason

Raison pour laquelle l’appel s’est produit. Ce membre peut être l’une des constantes LINECALLREASON_.

dwCompletionID

Identificateur d’achèvement de l’appel entrant s’il est le résultat d’une demande d’achèvement qui se termine. Cet identificateur n’est significatif que si dwReason est LINECALLREASON_CALLCOMPLETION.

dwNumOwners

Nombre de modules d’application avec différents handles d’appel avec le privilège de propriétaire pour l’appel.

dwNumMonitors

Nombre de modules d’application avec différents handles d’appel avec un privilège de supervision pour l’appel.

dwCountryCode

Code de pays ou de région de la partie de destination. Zéro si inconnu.

dwTrunk

Numéro de la jonction sur laquelle l’appel est acheminé. Ce membre est utilisé pour les appels entrants et sortants. Le membre dwTrunk doit être défini sur 0xFFFFFFFF s’il est inconnu.

dwCallerIDFlags

Détermine la validité et le contenu des informations d’identificateur de partie de l’appelant ou de l’initiateur. Ce membre utilise l’une des constantes LINECALLPARTYID_.

dwCallerIDSize

Taille du numéro d’ID de l’appelant, en octets.

dwCallerIDOffset

Décalage entre le début de cette structure et le champ de taille variable contenant les informations d’IDENTIFICATION de la partie appelante. La taille du champ est spécifiée par dwCallerIDSize.

dwCallerIDNameSize

Taille du nom de l’ID de l’appelant, y compris le terminateur null, en octets.

dwCallerIDNameOffset

Décalage entre le début de cette structure et le champ de taille variable contenant les informations de nom d’ID de partie appelante. La taille du champ est spécifiée par dwCallerIDNameSize.

dwCalledIDFlags

Détermine la validité et le contenu des informations d’ID de partie appelée. La partie appelée correspond à la partie initialement adressée. Ce membre utilise l’une des constantes LINECALLPARTYID_.

dwCalledIDSize

Taille du numéro d’ID du tiers appelé, en octets.

dwCalledIDOffset

Décalage entre le début de la structure et le champ de taille variable contenant les informations de numéro d’ID de partie appelée. La taille du champ est spécifiée par dwCalledIDSize.

dwCalledIDNameSize

Taille du nom d’ID de partie appelée, y compris la fin null, en octets.

dwCalledIDNameOffset

Décalage entre le début de la structure et le champ de taille variable contenant les informations de nom d’ID de partie appelée. La taille du champ est spécifiée par dwCalledIDNameSize.

dwConnectedIDFlags

Détermine la validité et le contenu des informations d’ID de partie connectée. La partie connectée est la partie à laquelle était réellement connectée. Cela peut être différent de l’ID de partie appelée si l’appel a été détourné. Ce membre utilise l’une des constantes LINECALLPARTYID_.

dwConnectedIDSize

Taille du numéro d’ID de partie connectée, en octets.

dwConnectedIDOffset

Décalage entre le début de cette structure et le champ de taille variable contenant les informations de numéro d’ID de partie connectée. La taille du champ est spécifiée par dwConnectedIDSize.

dwConnectedIDNameSize

Taille du nom de l’ID de partie connectée, y compris la fin null, en octets.

dwConnectedIDNameOffset

Décalage entre le début de cette structure et le champ de taille variable contenant les informations de nom d’ID de partie connectée. La taille du champ est spécifiée par dwConnectedIDNameSize.

dwRedirectionIDFlags

Détermine la validité et le contenu des informations d’identificateur de partie de redirection. La partie de redirection identifie l’adresse vers laquelle la session a été redirigée. Ce membre utilise l’une des constantes LINECALLPARTYID_.

dwRedirectionIDSize

Taille du numéro d’ID de partie de redirection, en octets.

dwRedirectionIDOffset

Décalage entre le début de la structure et le champ de taille variable contenant les informations de numéro d’ID de partie de redirection. La taille du champ est spécifiée par dwRedirectionIDSize.

dwRedirectionIDNameSize

Taille du nom de l’ID de partie de redirection, en octets.

dwRedirectionIDNameOffset

Décalage du début de la structure vers le champ de taille variable contenant les informations de nom d’ID de partie de redirection. La taille du champ est spécifiée par dwRedirectionIDNameSize.

dwRedirectingIDFlags

Détermine la validité et le contenu des informations d’identificateur de partie redirigée. La partie qui redirige identifie l’adresse qui redirige la session. Ce membre utilise l’une des constantes LINECALLPARTYID_.

dwRedirectingIDSize

Taille du numéro d’ID de la partie de redirection, en octets.

dwRedirectingIDOffset

Décalage entre le début de la structure et le champ de taille variable contenant les informations de numéro d’ID de la partie de redirection. La taille du champ est spécifiée par dwRedirectingIDSize.

dwRedirectingIDNameSize

Taille du nom de l’ID de la partie de redirection, y compris la fin null, en octets.

dwRedirectingIDNameOffset

Décalage du début de la structure vers le champ de taille variable contenant les informations de nom de l’ID de partie de redirection. La taille du champ est spécifiée par dwRedirectingIDNameSize.

dwAppNameSize

Taille du champ nom de l’application, y compris la marque de fin Null, en octets.

dwAppNameOffset

Décalage entre le début de la structure et le champ de taille variable contenant le nom convivial de l’application qui a d’abord créé, accepté ou répondu à l’appel. Il s’agit du nom qu’une application peut spécifier dans lineInitializeEx. Si l’application ne spécifie aucun nom de ce type, le nom de fichier du module de l’application est utilisé à la place. La taille du champ est spécifiée par dwAppNameSize.

dwDisplayableAddressSize

Taille de la chaîne d’adresse affichable, y compris la marque de fin Null, en octets.

dwDisplayableAddressOffset

La chaîne affichable est utilisée à des fins de journalisation. Les informations sont obtenues à partir de LINECALLPARAMS pour les fonctions qui lancent des appels. La fonction lineTranslateAddress retourne les informations appropriées à placer dans ce champ dans les membres dwDisplayableAddressSize et dwDisplayableAddressOffset de la structure LINETRANSLATEOUTPUT .

dwCalledPartySize

Taille du champ de description du tiers appelé, en octets.

dwCalledPartyOffset

Décalage du début de la structure vers le champ de taille variable qui spécifie la description conviviale de la partie appelée. Ces informations peuvent être spécifiées avec lineMakeCall et peuvent éventuellement être spécifiées dans le paramètre lpCallParams chaque fois qu’un nouvel appel est établi. Il est utile pour la journalisation des appels. La taille du champ est spécifiée par dwCalledPartySize.

dwCommentSize

Taille du champ de commentaire, en octets.

dwCommentOffset

Décalage du début de la structure vers le champ de taille variable contenant un commentaire sur l’appel fourni par l’application à l’origine de l’appel à l’aide de lineMakeCall. Ces informations peuvent éventuellement être spécifiées dans le paramètre lpCallParams chaque fois qu’un nouvel appel est établi. La taille du champ est spécifiée par dwCommentSize.

dwDisplaySize

Taille des informations d’affichage brutes, en octets.

dwDisplayOffset

Décalage du début de la structure vers le champ de taille variable contenant les informations d’affichage brutes. Selon l’environnement de téléphonie, un fournisseur de services peut extraire des informations fonctionnelles de cette paire de membres pour la mise en forme et la présentation les plus appropriées pour cette configuration de téléphonie. La taille du champ est spécifiée par dwDisplaySize.

dwUserUserInfoSize

Taille des informations utilisateur-utilisateur, en octets. Si les informations utilisateur-utilisateur sont un pointeur vers une chaîne, la taille doit inclure la marque de fin Null.

dwUserUserInfoOffset

Décalage du début de la structure vers le champ de taille variable contenant des informations utilisateur-utilisateur. Le champ de discrimination de protocole pour les informations utilisateur-utilisateur, s’il est utilisé, apparaît comme le premier octet des données pointées par dwUserInfoOffset et est pris en compte dans dwUserUserInfoSize.

dwHighLevelCompSize

Taille des informations de compatibilité de haut niveau, en octets.

dwHighLevelCompOffset

Décalage du début de la structure vers le champ de taille variable contenant des informations de compatibilité de haut niveau. Le format de ces informations est spécifié par d’autres normes (R ISDN Q.931). La taille du champ est spécifiée par dwHighLevelCompSize.

dwLowLevelCompSize

Taille des informations de compatibilité de bas niveau, en octets.

dwLowLevelCompOffset

Décalage du début de la structure vers le champ de taille variable contenant des informations de compatibilité de bas niveau. Le format de ces informations est spécifié par d’autres normes (R ISDN Q.931). La taille du champ est spécifiée par dwLowLevelCompSize.

dwChargingInfoSize

Taille des informations de chargement, en octets.

dwChargingInfoOffset

Décalage du début de la structure vers le champ de taille variable contenant les informations de charge. Le format de ces informations est spécifié par d’autres normes (R ISDN Q.931). La taille du champ est spécifiée par dwChargingInfoSize.

dwTerminalModesSize

Taille du tableau des modes de terminal actuels, en octets.

dwTerminalModesOffset

Décalage du début de la structure vers le champ d’appareil de taille variable contenant un tableau avec des entrées de taille DWORD. Les entrées de tableau sont indexées par identificateurs de terminal, dans la plage comprise entre zéro et un inférieur à dwNumTerminals. Chaque entrée du tableau spécifie les modes de terminal actuels pour le jeu de terminaux correspondant avec la fonction lineSetTerminal pour le flux multimédia de cet appel, comme spécifié par l’une des constantes LINETERMMODE_. La taille du tableau est spécifiée par dwTerminalModesSize.

dwDevSpecificSize

Taille du champ spécifique à l’appareil, en octets.

dwDevSpecificOffset

Décalage du début de la structure vers le champ de taille variable contenant des informations spécifiques à l’appareil. La taille du champ est spécifiée par dwDevSpecificSize.

dwCallTreatment

Traitement d’appel actuellement appliqué à l’appel ou appliqué lorsque l’appel passe à l’état applicable suivant. Peut être zéro si les traitements d’appel ne sont pas pris en charge.

dwCallDataSize

Taille des données d’appel définissables par l’application, en octets.

dwCallDataOffset

Décalage du début de la structure vers les données d’appel définissables par l’application. La taille du champ est spécifiée par dwCallDataSize.

dwSendingFlowspecSize

Taille des informations de qualité de service, en octets.

dwSendingFlowspecOffset

Décalage du début de la structure vers une structure FLOWSPEC suivie de données spécifiques au fournisseur WinSock, équivalent à ce qui aurait été stocké dans SendingFlowspec dans une structure QOS . Spécifie la qualité de service actuellement en vigueur dans le sens d’envoi de l’appel. La partie spécifique au fournisseur qui suit la structure FLOWSPEC ne doit pas contenir de pointeurs vers d’autres blocs de mémoire, car TAPI ne sait pas comment marshaler les données pointées par le ou les pointeurs privés et les transmettre par le biais d’une communication interprocessus vers l’application. La taille du champ est spécifiée par dwSendingFlowspecSize.

dwReceivingFlowspecSize

Taille des informations de qualité de service, en octets.

dwReceivingFlowspecOffset

Décalage du début de la structure vers une structure FLOWSPEC suivie de données spécifiques au fournisseur WinSock, équivalent à ce qui aurait été stocké dans ReceiveingFlowspec dans une structure QOS . Spécifie la qualité de service en vigueur dans le sens de réception de l’appel. La partie spécifique au fournisseur qui suit la structure FLOWSPEC ne doit pas contenir de pointeurs vers d’autres blocs de mémoire, car TAPI ne sait pas comment marshaler les données pointées par le ou les pointeurs privés et les transmettre par le biais d’une communication interprocessus vers l’application. La taille du champ est spécifiée par dwReceivingFlowspecSize.

dwCallerIDAddressType

Type d’adresse de l’appelant. Ce membre de la structure est disponible uniquement si la version TAPI négociée est 3.0 ou ultérieure.

dwCalledIDAddressType

Type d’adresse de la partie appelée. Ce membre de la structure est disponible uniquement si la version TAPI négociée est 3.0 ou ultérieure.

dwConnectedIDAddressType

Type d’adresse de la destination à laquelle l’appel a été connecté. Ce membre de la structure est disponible uniquement si la version TAPI négociée est 3.0 ou ultérieure.

dwRedirectionIDAddressType

Type d’adresse de la nouvelle destination d’appel. Ce membre de la structure est disponible uniquement si la version TAPI négociée est 3.0 ou ultérieure.

dwRedirectingIDAddressType

Type d’adresse de l’emplacement qui a redirigé l’appel. Ce membre de la structure est disponible uniquement si la version TAPI négociée est 3.0 ou ultérieure.

Remarques

Les extensions spécifiques à l’appareil doivent utiliser la zone DevSpecific (dwDevSpecificSize et dwDevSpecificOffset) de taille variable de cette structure de données.

La structure de données LINECALLINFO contient des informations relativement fixes sur un appel. Cette structure est retournée avec lineGetCallInfo. Lorsque les éléments d’informations de cette structure de données ont changé, un message LINE_CALLINFO est envoyé à l’application. Un paramètre de ce message est l’élément d’information ou le champ qui a changé.

Les membres dwCallTreatment et dwReceivingFlowspecOffset sont disponibles uniquement pour les applications qui ouvrent l’appareil de ligne avec une version d’API 2.0 ou ultérieure.

Note Le format par défaut pour la spécification du contenu du champ dwCallID et des cinq autres champs similaires (dwCallerIDFlag, dwCallerIDSize, dwCallerIDOffset, dwCallerIDNameSize et dwCallerIDNameOffset) est le format de nombre canonique TAPI. Par exemple, un ICLID de « 4258828080 » reçu du commutateur doit être converti en « +1 (425) 8828080 » avant d’être placé dans la structure LINECALLINFO . Ce format standardisé facilite la recherche dans les bases de données et les fonctions de rappel implémentées dans les applications.
 

Configuration requise

Condition requise Valeur
En-tête tapi.h

Voir aussi

LINECALLSTATUS

LINEDEVCAPS

LINEDIALPARAMS

LINETRANSLATEOUTPUT

LINE_CALLINFO

LINE_MONITORMEDIA

TSPI_lineGetCallInfo

lineGenerateDigits

lineGetCallInfo

lineGetCallStatus

lineInitializeEx

lineMakeCall

lineSecureCall

lineSetAppSpecific

lineSetCallParams

lineSetTerminal

lineTranslateAddress