STRUCTURE LINEADDRESSCAPS (tapi.h)

Article
08/26/2023

La structure LINEADDRESSCAPS décrit les fonctionnalités d’une adresse spécifiée. La fonction lineGetAddressCaps et la fonction TSPI_lineGetAddressCaps retournent la structure LINEADDRESSCAPS .

Syntaxe

typedef struct lineaddresscaps_tag {
  DWORD dwTotalSize;
  DWORD dwNeededSize;
  DWORD dwUsedSize;
  DWORD dwLineDeviceID;
  DWORD dwAddressSize;
  DWORD dwAddressOffset;
  DWORD dwDevSpecificSize;
  DWORD dwDevSpecificOffset;
  DWORD dwAddressSharing;
  DWORD dwAddressStates;
  DWORD dwCallInfoStates;
  DWORD dwCallerIDFlags;
  DWORD dwCalledIDFlags;
  DWORD dwConnectedIDFlags;
  DWORD dwRedirectionIDFlags;
  DWORD dwRedirectingIDFlags;
  DWORD dwCallStates;
  DWORD dwDialToneModes;
  DWORD dwBusyModes;
  DWORD dwSpecialInfo;
  DWORD dwDisconnectModes;
  DWORD dwMaxNumActiveCalls;
  DWORD dwMaxNumOnHoldCalls;
  DWORD dwMaxNumOnHoldPendingCalls;
  DWORD dwMaxNumConference;
  DWORD dwMaxNumTransConf;
  DWORD dwAddrCapFlags;
  DWORD dwCallFeatures;
  DWORD dwRemoveFromConfCaps;
  DWORD dwRemoveFromConfState;
  DWORD dwTransferModes;
  DWORD dwParkModes;
  DWORD dwForwardModes;
  DWORD dwMaxForwardEntries;
  DWORD dwMaxSpecificEntries;
  DWORD dwMinFwdNumRings;
  DWORD dwMaxFwdNumRings;
  DWORD dwMaxCallCompletions;
  DWORD dwCallCompletionConds;
  DWORD dwCallCompletionModes;
  DWORD dwNumCompletionMessages;
  DWORD dwCompletionMsgTextEntrySize;
  DWORD dwCompletionMsgTextSize;
  DWORD dwCompletionMsgTextOffset;
  DWORD dwAddressFeatures;
  DWORD dwPredictiveAutoTransferStates;
  DWORD dwNumCallTreatments;
  DWORD dwCallTreatmentListSize;
  DWORD dwCallTreatmentListOffset;
  DWORD dwDeviceClassesSize;
  DWORD dwDeviceClassesOffset;
  DWORD dwMaxCallDataSize;
  DWORD dwCallFeatures2;
  DWORD dwMaxNoAnswerTimeout;
  DWORD dwConnectedModes;
  DWORD dwOfferingModes;
  DWORD dwAvailableMediaModes;
} LINEADDRESSCAPS, *LPLINEADDRESSCAPS;

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.

dwLineDeviceID

Identificateur d’appareil de l’appareil de ligne auquel cette adresse est associée.

dwAddressSize

Taille du champ d’adresse, en octets.

dwAddressOffset

Décalage entre le début de la structure et le champ d’adresse de taille variable. La taille du champ est spécifiée par dwAddressSize.

dwDevSpecificSize

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

dwDevSpecificOffset

Décalage entre le début de la structure et le champ spécifique à l’appareil de taille variable. La taille du champ est spécifiée par dwDevSpecificSize.

dwAddressSharing

Mode de partage de l’adresse. Ce membre peut être l’une des constantes LINEADDRESSSHARING_.

dwAddressStates

Changements d’états d’adresse pour lesquels l’application peut être avertie dans le message LINE_ADDRESSSTATE. Ce membre utilise une ou plusieurs constantes LINEADDRESSSTATE_.

dwCallInfoStates

Éléments d’informations d’appel qui sont significatifs pour tous les appels sur cette adresse. Une application peut être informée des modifications apportées à certains de ces états dans LINE_CALLINFO messages. Ce membre utilise une ou plusieurs constantes LINECALLINFOSTATE_.

dwCallerIDFlags

Types d’informations d’identificateur de partie qui peuvent être fournis pour les appels sur cette adresse. L’appelant est l’initiateur de la session. Une ou plusieurs constantes LINECALLPARTYID_.

dwCalledIDFlags

Types d’informations d’identificateur de partie qui peuvent être fournis pour les appels sur cette adresse. Ici, « appelé » fait référence à la destination d’origine. Une ou plusieurs constantes LINECALLPARTYID_.

dwConnectedIDFlags

Types d’informations d’identificateur de partie qui peuvent être fournis pour les appels sur cette adresse. Une ou plusieurs constantes LINECALLPARTYID_.

dwRedirectionIDFlags

Types d’informations d’identificateur de partie qui peuvent être fournis pour les appels sur cette adresse. Ici, la « redirection » est la nouvelle destination. Une ou plusieurs constantes LINECALLPARTYID_.

dwRedirectingIDFlags

Types d’informations d’identificateur de partie qui peuvent être fournis pour les appels sur cette adresse. Ici, « redirection » est l’adresse qui a appelé la redirection. Une ou plusieurs constantes LINECALLPARTYID_.

dwCallStates

États d’appel qui peuvent être signalés pour les appels sur cette adresse. Ce membre utilise une ou plusieurs constantes LINECALLSTATE_.

dwDialToneModes

Modes de tonalité de numérotation qui peuvent être signalés pour les appels effectués sur cette adresse. Ce membre n’a de sens que si l’état de l’appel de la numérotation peut être signalé. Ce membre utilise une ou plusieurs constantes LINEDIALTONEMODE_.

dwBusyModes

Modes occupés qui peuvent être signalés pour les appels effectués sur cette adresse. Ce membre n’a de sens que si l’état d’appel occupé peut être signalé. Ce membre utilise une ou plusieurs constantes LINEBUSYMODE_.

dwSpecialInfo

Types d’informations spéciaux qui peuvent être signalés pour les appels effectués sur cette adresse. Ce membre n’a de sens que si l’état de l’appel specialInfo peut être signalé. Ce membre utilise une ou plusieurs constantes LINESPECIALINFO_.

dwDisconnectModes

Modes de déconnexion qui peuvent être signalés pour les appels effectués sur cette adresse. Ce membre est significatif uniquement si l’état de l’appel déconnecté peut être signalé. Ce membre utilise une ou plusieurs constantes LINEDISCONNECTMODE_.

dwMaxNumActiveCalls

Nombre maximal d’apparences d’appel actifs que l’adresse peut gérer. Ce numéro n’inclut pas les appels en attente ou en attente de transfert ou de conférence.

dwMaxNumOnHoldCalls

Nombre maximal d’apparences d’appel à l’adresse qui peuvent être en attente.

dwMaxNumOnHoldPendingCalls

Nombre maximal d’apparences d’appel à l’adresse qui peuvent être en attente de transfert ou de conférence.

dwMaxNumConference

Nombre maximal de parties pouvant participer à une seule conférence téléphonique à cette adresse.

dwMaxNumTransConf

Nombre de parties (y compris le « self ») qui peuvent être ajoutées à une téléconférence lancée en tant qu’appel de consultation générique à l’aide de lineSetupTransfer.

dwAddrCapFlags

Indicateurs de bits empaquetés qui décrivent diverses fonctionnalités d’adresse. Ce membre utilise une ou plusieurs constantes LINEADDRCAPFLAGS_.

dwCallFeatures

Fonctionnalités de basculement ou fonctionnalités disponibles pour tous les appels sur cette adresse à l’aide des constantes LINECALLFEATURE_. Ce membre représente les fonctionnalités liées aux appels qui peuvent éventuellement être disponibles sur une adresse (disponibilité statique par opposition à la disponibilité dynamique). L’appel d’une fonctionnalité prise en charge nécessite que l’appel soit dans le bon état et que l’appareil de ligne sous-jacent soit ouvert en mode compatible. Un zéro dans une position de bit indique que la fonctionnalité correspondante n’est jamais disponible. Un indique que la fonctionnalité correspondante peut être disponible si l’application dispose des privilèges appropriés pour l’appel et si l’appel est dans l’état approprié pour que l’opération soit significative. Ce membre permet à une application de découvrir quelles fonctionnalités d’appel peuvent être (et qui ne peuvent jamais être) prises en charge par l’adresse.

dwRemoveFromConfCaps

Fonctionnalités d’Address pour la suppression d’appels d’une téléconférence. Ce membre utilise l’une des constantes LINEREMOVEFROMCONF_.

dwRemoveFromConfState

Utilise les constantes LINECALLSTATE_ pour spécifier l’état de l’appel après sa suppression d’une conférence téléphonique.

dwTransferModes

Fonctionnalités d’Address pour résoudre les demandes de transfert. Ce membre utilise l’une des constantes LINETRANSFERMODE_.

dwParkModes

Différents modes de parc d’appels disponibles à cette adresse. Ce membre utilise l’une des constantes LINEPARKMODE_.

dwForwardModes

Différents modes de transfert disponibles pour cette adresse. Ce membre utilise les constantes LINEFORWARDMODE_.

dwMaxForwardEntries

Nombre maximal d’entrées pouvant être passées à lineForward dans le paramètre lpForwardList .

dwMaxSpecificEntries

Nombre maximal d’entrées dans le paramètre lpForwardList passées à lineForward qui peuvent contenir des instructions de transfert basées sur un ID d’appelant spécifique (transfert d’appel sélectif). Ce membre est égal à zéro si le transfert d’appel sélectif n’est pas pris en charge.

dwMinFwdNumRings

Nombre minimal d’anneaux qui peuvent être définis pour déterminer quand un appel est officiellement considéré comme « aucune réponse ».

dwMaxFwdNumRings

Nombre maximal d’anneaux qui peuvent être définis pour déterminer quand un appel est officiellement considéré comme « aucune réponse ». Si ce nombre d’anneaux ne peut pas être défini, dwMinFwdNumRings et dwMaxNumRings sont égaux.

dwMaxCallCompletions

Nombre maximal de demandes de fin d’appel simultanées qui peuvent être en attente sur cet appareil de ligne. Zéro implique que l’achèvement de l’appel n’est pas disponible.

dwCallCompletionConds

Différentes conditions d’appel dans lesquelles l’achèvement de l’appel peut être demandé. Ce membre utilise une ou plusieurs constantes LINECALLCOMPLCOND_.

dwCallCompletionModes

Manière dont l’appel peut être effectué. Ce membre utilise l’une des constantes LINECALLCOMPLMODE_.

dwNumCompletionMessages

Nombre de messages de fin d’appel qui peuvent être sélectionnés lors de l’utilisation de l’option LINECALLCOMPLMODE_MESSAGE. Les messages individuels sont identifiés par des valeurs comprises dans la plage zéro à une valeur inférieure à dwNumCompletionMessages.

dwCompletionMsgTextEntrySize

Taille de chacune des descriptions de texte de fin d’appel spécifiées par dwCompletionMsgTextSize et dwCompletionMsgTextOffset, en octets.

dwCompletionMsgTextSize

Taille du texte de fin de l’appel, en octets.

dwCompletionMsgTextOffset

Décalage entre le début de cette structure de données et le champ de taille variable contenant du texte descriptif sur chacun des messages de fin d’appel. Chaque message est long en octets dwCompletionMsgTextEntrySize . Le format de chaîne de ces descriptions textuelles est indiqué par dwStringFormat dans les fonctionnalités de l’appareil de la ligne. La taille du champ est spécifiée par dwCompletionMsgTextSize.

dwAddressFeatures

Fonctionnalités disponibles pour cette adresse à l’aide des constantes LINEADDRFEATURE_. L’appel d’une fonctionnalité prise en charge nécessite que l’adresse soit dans le bon état et que l’appareil de ligne sous-jacent soit ouvert en mode compatible. Un zéro dans une position de bit indique que la fonctionnalité correspondante n’est jamais disponible. Un indique que la fonctionnalité correspondante peut être disponible si l’adresse est dans l’état approprié pour que l’opération soit significative. Ce membre permet à une application de découvrir quelles fonctionnalités d’adresse peuvent être (et qui ne peuvent jamais être) prises en charge par l’adresse.

dwPredictiveAutoTransferStates

État d’appel ou états sur lesquels un appel effectué par un numéroteur prédictif peut être défini pour transférer automatiquement l’appel vers une autre adresse ; une ou plusieurs constantes LINECALLSTATE_. La valeur 0 indique que le transfert automatique basé sur l’état de l’appel n’est pas disponible.

dwNumCallTreatments

Nombre d’entrées dans le tableau de structures LINECALLTREATMENTENTRY délimitées par dwCallTreatmentListSize et dwCallTreatmentListOffset.

dwCallTreatmentListSize

Taille du tableau de traitement des appels, en octets.

dwCallTreatmentListOffset

Décaler du début de la structure vers un tableau de structures LINECALLTREATMENTENTRY pour spécifier les traitements d’appel pris en charge sur l’adresse (qui peuvent être sélectionnés à l’aide de lineSetCallTreatment). La valeur est dwNumCallTreatments times SIZEOF(LINECALLTREATMENTENTRY). La taille du champ est spécifiée par dwCallTreatmentListSize.

dwDeviceClassesSize

Taille de la liste des classes d’appareils prises en charge, en octets.

dwDeviceClassesOffset

Décalage du début de la structure vers une chaîne composée des identificateurs de classe d’appareil pris en charge sur cette adresse pour une utilisation avec lineGetID. Les éléments sont séparés par des caractères Null , et le dernier identificateur de classe est suivi de deux caractères Null . La taille du champ est spécifiée par dwDeviceClassesSize.

dwMaxCallDataSize

Nombre maximal d’octets qu’une application peut définir dans LINECALLINFO à l’aide de lineSetCallData.

dwCallFeatures2

Fonctionnalités de basculement supplémentaires disponibles pour tous les appels sur cette adresse à l’aide des constantes LINECALLFEATURE2_. Il s’agit d’une extension du membre dwCallFeatures .

dwMaxNoAnswerTimeout

Valeur maximale en secondes qui peut être définie dans le membre dwNoAnswerTimeout dans LINECALLPARAMS lors d’un appel. La valeur 0 indique que l’abandon automatique des appels sans réponse n’est pas pris en charge par le fournisseur de services, ou que la valeur du délai d’expiration n’est pas réglable par les applications.

dwConnectedModes

LINECONNECTEDMODE_ valeurs qui peuvent apparaître dans le membre dwCallStateMode de LINECALLSTATUS et dans les messages LINE_CALLSTATE pour les appels sur cette adresse.

dwOfferingModes

LINEOFFERINGMODE_ valeurs qui peuvent apparaître dans le membre dwCallStateMode de LINECALLSTATUS et dans les messages LINE_CALLSTATE pour les appels sur cette adresse.

dwAvailableMediaModes

Types de médias (modes) qui peuvent être appelés sur les nouveaux appels créés sur cette adresse, lorsque le membre dwAddressFeatures indique que de nouveaux appels sont possibles. Si ce membre est égal à zéro, cela indique que le fournisseur de services ne sait pas ou ne peut pas indiquer quels types de médias sont disponibles, auquel cas tout ou partie des types de médias indiqués dans le membre dwMediaModes dans LINEDEVCAPS peut être disponible.

Remarques

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

Les applications plus anciennes sont compilées sans ce membre dans la structure LINEADDRESSCAPS et à l’aide d’un SIZEOF(LINEADDRESSCAPS) plus petit que la nouvelle taille. L’application transmet un paramètre dwAPIVersion avec la fonction lineGetAddressCaps , qui peut être utilisée pour l’aide de TAPI dans la gestion de cette situation. Si l’application transmet un membre dwTotalSize inférieur à la taille de la partie fixe de la structure définie dans le membre dwAPIVersion spécifié, LINEERR_STRUCTURETOOSMALL est retourné. Si suffisamment de mémoire a été allouée par l’application, avant d’appeler TSPI_lineGetAddressCaps, TAPI définit les membres dwNeededSize et dwUsedSize sur la taille fixe de la structure telle qu’elle existait dans la version d’API spécifiée.

Les nouveaux fournisseurs de services (qui prennent en charge la nouvelle version de l’API) doivent examiner la version de l’API passée. Si la version de l’API est inférieure à la version la plus élevée prise en charge par le fournisseur, le fournisseur de services ne doit pas renseigner les champs non pris en charge dans les versions antérieures de l’API, car ceux-ci se trouvent dans la partie variable de l’ancienne structure.

Les nouvelles applications doivent être conscientes de la version de l’API négociée et ne pas examiner le contenu des champs dans la partie fixe au-delà de la fin d’origine de la partie fixe de la structure pour la version d’API négociée.

Les membres dwPredictiveAutoTransferStates via dwAvailableMediaModes sont disponibles uniquement pour les applications qui demandent une version d’API 2.0 ou ultérieure lors de l’appel de lineGetAddressCaps.