STRUCTURE LINECALLPARAMS (tapi.h)

Article
02/05/2024

La structure LINECALLPARAMS décrit les paramètres fournis lors de l’exécution d’appels à l’aide des fonctions lineMakeCall et TSPI_lineMakeCall . La structure LINECALLPARAMS est également utilisée comme paramètre dans d’autres opérations, telles que la fonction lineOpen .

Les commentaires à droite du bloc de syntaxe indiquent les valeurs par défaut utilisées lorsque cette structure n’est pas fournie à lineMakeCall.

Syntaxe

typedef struct linecallparams_tag {
  DWORD          dwTotalSize;
  DWORD          dwBearerMode;
  DWORD          dwMinRate;
  DWORD          dwMaxRate;
  DWORD          dwMediaMode;
  DWORD          dwCallParamFlags;
  DWORD          dwAddressMode;
  DWORD          dwAddressID;
  LINEDIALPARAMS DialParams;
  DWORD          dwOrigAddressSize;
  DWORD          dwOrigAddressOffset;
  DWORD          dwDisplayableAddressSize;
  DWORD          dwDisplayableAddressOffset;
  DWORD          dwCalledPartySize;
  DWORD          dwCalledPartyOffset;
  DWORD          dwCommentSize;
  DWORD          dwCommentOffset;
  DWORD          dwUserUserInfoSize;
  DWORD          dwUserUserInfoOffset;
  DWORD          dwHighLevelCompSize;
  DWORD          dwHighLevelCompOffset;
  DWORD          dwLowLevelCompSize;
  DWORD          dwLowLevelCompOffset;
  DWORD          dwDevSpecificSize;
  DWORD          dwDevSpecificOffset;
  DWORD          dwPredictiveAutoTransferStates;
  DWORD          dwTargetAddressSize;
  DWORD          dwTargetAddressOffset;
  DWORD          dwSendingFlowspecSize;
  DWORD          dwSendingFlowspecOffset;
  DWORD          dwReceivingFlowspecSize;
  DWORD          dwReceivingFlowspecOffset;
  DWORD          dwDeviceClassSize;
  DWORD          dwDeviceClassOffset;
  DWORD          dwDeviceConfigSize;
  DWORD          dwDeviceConfigOffset;
  DWORD          dwCallDataSize;
  DWORD          dwCallDataOffset;
  DWORD          dwNoAnswerTimeout;
  DWORD          dwCallingPartyIDSize;
  DWORD          dwCallingPartyIDOffset;
  DWORD          dwAddressType;
} LINECALLPARAMS, *LPLINECALLPARAMS;

Membres

dwTotalSize

Taille totale allouée à cette structure de données, en octets. Cette taille doit être suffisamment grande pour contenir toutes les parties fixes et de taille variable de cette structure de données.

dwBearerMode

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

Si dwBearerMode est égal à zéro, la valeur par défaut est LINEBEARERMODE_VOICE.

dwMinRate

Débit de données minimal demandé pour le flux de données de l’appel, en bps (bits par seconde).

dwMaxRate

Débit de données maximal demandé pour le flux de données de l’appel, en bps (bits par seconde). Lors d’un appel, le fournisseur de services tente de fournir le taux disponible le plus élevé dans la plage demandée (dwMinRate à dwMaxRate). Si un débit de données spécifique est requis, dwMinRate et dwMaxRate doivent être définis sur cette valeur. Si une application fonctionne mieux avec un taux, mais qu’elle peut passer à des taux inférieurs, l’application doit les spécifier comme taux maximum et minimum, respectivement. Si dwMaxRate est égal à zéro, la valeur par défaut est spécifiée par le membre dwMaxRate de la structure LINEDEVCAPS . Il s’agit du débit maximal pris en charge par l’appareil.

dwMediaMode

Type de média attendu de l’appel. Ce membre utilise l’une des constantes LINEMEDIAMODE_.

Si dwMediaMode est égal à zéro, la valeur par défaut est LINEMEDIAMODE_INTERACTIVEVOICE.

dwCallParamFlags

Collection de paramètres de configuration des appels booléens. Ce membre utilise une ou plusieurs constantes LINECALLPARAMFLAGS_.

dwAddressMode

Mode par lequel l’adresse d’origine est spécifiée. Ce membre utilise l’une des constantes LINEADDRESSMODE_.

Note Le membre dwAddressMode ne peut pas être LINEADDRESSMODE_ADDRESSID pour l’appel de fonction lineOpen . Toutefois, cette restriction ne s’applique pas à lineMakeCall.

dwAddressID

Identificateur d’adresse de l’adresse d’origine si dwAddressMode est défini sur LINEADDRESSMODE_ADDRESSID. Un identificateur d’adresse est associé de manière permanente à une adresse ; l’identificateur reste constant entre les mises à niveau du système d’exploitation.

DialParams

Paramètres de numérotation à utiliser sur cet appel, de type LINEDIALPARAMS. Quand la valeur 0 est spécifiée pour ce champ, la valeur par défaut du champ est utilisée comme indiqué dans le membre DefaultDialParams de la structure LINEDEVCAPS . Si une valeur différente de zéro est spécifiée pour un champ qui se trouve en dehors de la plage spécifiée par les champs correspondants dans MinDialParams et MaxDialParams dans la structure LINEDEVCAPS , la valeur la plus proche dans la plage valide est utilisée à la place.

dwOrigAddressSize

Taille du champ d’adresse d’origine, en octets.

dwOrigAddressOffset

Décalage du début de la structure vers le champ de taille variable contenant l’adresse d’origine. Le format de cette adresse dépend du membre dwAddressMode . La taille du champ est spécifiée par dwOrigAddressSize.

dwDisplayableAddressSize

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

dwDisplayableAddressOffset

Chaîne affichable utilisée à des fins de journalisation. Le contenu de ces membres est enregistré dans les membres dwDisplayableAddressOffset et dwDisplayableAddressSize du message LINECALLINFO de l’appel. La fonction lineTranslateAddress retourne les informations appropriées à placer dans ce champ dans les membres dwDisplayableAddressSize et dwDisplayableAddressOffset de la structure LINETRANSLATEOUTPUT . La taille du champ est spécifiée par dwDisplayableAddressSize.

dwCalledPartySize

Taille des informations du tiers appelé, en octets.

dwCalledPartyOffset

Décalage entre le début de la structure et le champ de taille variable contenant des informations sur les parties appelées. Ces informations peuvent être spécifiées par l’application qui effectue l’appel et sont mises à disposition dans la structure d’informations de l’appel à des fins de journalisation. Le format de ce champ est celui de dwStringFormat, comme spécifié dans LINEDEVCAPS. La taille du champ est spécifiée par dwCalledPartySize.

dwCommentSize

Taille du champ de commentaire d’appel, en octets.

dwCommentOffset

Décalage du début de la structure vers le champ de taille variable contenant des commentaires sur l’appel. Ces informations peuvent être spécifiées par l’application qui effectue l’appel et sont mises à disposition dans la structure d’informations de l’appel à des fins de journalisation. Le format de ce champ est celui de dwStringFormat, comme spécifié dans LINEDEVCAPS. La taille du champ est spécifiée par dwCommentSize.

dwUserUserInfoSize

Taille des informations utilisateur-utilisateur, y compris la marque de fin Null , en octets.

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, si nécessaire, doit apparaître comme le premier octet des données pointées par dwUserInfoOffset, et doit être 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. 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. La taille du champ est spécifiée par dwLowLevelCompSize.

dwDevSpecificSize

Taille des informations spécifiques à 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.

dwPredictiveAutoTransferStates

LINECALLSTATE_ constantes, entrée dans laquelle l’appel est transféré en aveugle vers l’adresse cible spécifiée. Définissez sur zéro si le transfert automatique n’est pas souhaité.

dwTargetAddressSize

Taille de la chaîne d’adresse accessible en numérotation cible, y compris la marque de fin Null , en octets.

dwTargetAddressOffset

Décalage du début de la structure vers une chaîne spécifiant l’adresse de numérotation cible (et non dwAddressID) ; utilisé dans le cas de certaines actions automatiques. Dans le cas d’une numérotation prédictive, spécifie l’adresse vers laquelle l’appel doit être transféré automatiquement. La taille de la chaîne est spécifiée par dwTargetAddressSize.

Il s’agit essentiellement de la même chaîne qui serait passée à lineBlindTransfer si le transfert automatique n’était pas utilisé. Définissez sur zéro si le transfert automatique n’est pas souhaité. Dans le cas d’une conférence sans suspension, spécifie l’adresse qui doit être conférence à l’appel. Dans le cas d’un transfert en une seule étape, spécifie l’adresse à composer lors de l’appel de consultation.

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 souhaitée 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 souhaitée 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.

dwDeviceClassSize

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

dwDeviceClassOffset

Décalage du début de la structure vers une chaîne terminée par null qui indique la classe d’appareil de l’appareil dont la configuration est spécifiée dans DeviceConfig. Les chaînes de classe d’appareil valides sont les mêmes que celles spécifiées pour la fonction lineGetID . La taille de la chaîne est spécifiée par dwDeviceClassSize.

dwDeviceConfigSize

Taille des données de configuration de l’appareil, en octets.

dwDeviceConfigOffset

Décalage du début de la structure vers la structure de données de configuration opaque. Cette valeur est retournée dans le membre dwStringSize de la structure VARSTRING retournée par lineGetDevConfig. Si la taille est égale à zéro, la configuration d’appareil par défaut est utilisée. Cela permet à l’application de définir la configuration de l’appareil avant le lancement de l’appel. La taille du champ est spécifiée par dwDeviceConfigSize.

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 paramétrables par l’application à attacher initialement à l’appel. La taille du champ est spécifiée par dwCallDataSize.

dwNoAnswerTimeout

Nombre de secondes, après la fin de la numérotation, que l’appel doit être autorisé à attendre dans les états PROCEEDING ou RINGBACK, avant d’être automatiquement abandonné par le fournisseur de services avec un LINECALLSTATE_DISCONNECTED et LINEDISCONNECTMODE_NOANSWER. La valeur 0 indique que l’application ne souhaite pas l’abandon automatique des appels.

dwCallingPartyIDSize

Taille de la chaîne d’ID de partie appelante, y compris la fin null , en octets, y compris le caractère de fin null.

dwCallingPartyIDOffset

Décalage du début de la structure vers une chaîne terminée par null qui spécifie l’identité de la partie qui passe l’appel. Si le contenu de l’identificateur est acceptable et qu’un chemin d’accès est disponible, le fournisseur de services transmet l’identificateur à la partie appelée pour indiquer l’identité de la partie appelante. La taille du champ est spécifiée par dwCallingPartyIDSize.

dwAddressType

Type d’adresse utilisé pour l’appel. Ce membre de la structure n’est disponible que 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.

Cette structure est utilisée comme paramètre pour lineMakeCall lors de la configuration d’un appel. Ses champs permettent à l’application de spécifier la qualité de service demandée sur le réseau, ainsi qu’une variété de paramètres de configuration des appels ISDN. Si aucune structure LINECALLPARAMS n’est fournie à lineMakeCall, un appel de qualité vocale POTS par défaut est demandé avec les valeurs par défaut répertoriées ci-dessus.

Note Les champs DialParams via dwDevSpecificOffset sont ignorés lorsqu’un paramètre lpCallParams est spécifié avec la fonction lineOpen .

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