structure FAX_DEV_STATUS (faxdev.h)
La structure de FAX_DEV_STATUS contient des informations de status et d’identification sur une opération de télécopie active individuelle.
Syntaxe
typedef struct _FAX_DEV_STATUS {
DWORD SizeOfStruct;
DWORD StatusId;
DWORD StringId;
DWORD PageCount;
LPWSTR CSI;
LPWSTR CallerId;
LPWSTR RoutingInfo;
DWORD ErrorCode;
DWORD Reserved[3];
} FAX_DEV_STATUS, *PFAX_DEV_STATUS;
Membres
SizeOfStruct
Type : DWORD
Spécifie la taille, en octets, de la structure FAX_DEV_STATUS . Avant de répondre à la fonction FaxDevReportStatus , le FSP doit définir ce membre sur sizeof(FAX_DEV_STATUS).
StatusId
Type : DWORD
Spécifie un code ou une valeur de status de télécopie. Il peut s’agir d’un code d’status de télécopie prédéfini (illustré ci-dessous), d’un des codes d’erreur TAPI LINEERR_ Constantes ou d’une valeur définie par le FSP. Si l’identificateur status est défini par le fournisseur, le FSP doit également fournir une valeur pour le membre StringId. Voici les codes de status de télécopie prédéfinis.
| Valeur | Signification |
|---|---|
| FS_INITIALIZING | L’appel est en cours d’initialisation. |
| FS_DIALING | Le FSP compose des chiffres pour l’appel. |
| FS_TRANSMITTING | Le FSP transmet le document de télécopie. |
| FS_RECEIVING | Le FSP reçoit le document de télécopie. |
| FS_COMPLETED | L’appel de transmission de télécopie est terminé. |
| FS_LINE_UNAVAILABLE | Le FSP ne peut pas terminer l’appel, car l’appareil n’est pas disponible. |
| FS_BUSY | Le FSP a reçu un signal d’affluence. |
| FS_NO_ANSWER | Le FSP ne peut pas terminer l’appel, car l’appareil de réception ne répond pas. |
| FS_BAD_ADDRESS | Le FSP ne peut pas terminer l’appel, car l’adresse de destination n’est pas valide. |
| FS_NO_DIAL_TONE | Le FSP ne peut pas terminer l’appel, car il ne détecte pas de tonalité de numérotation. |
| FS_DISCONNECTED | L’appel a été déconnecté par l’appareil de réception. |
| FS_FATAL_ERROR | Une erreur irrécupérable s’est produite. |
| FS_NOT_FAX_CALL | L’appel est un appel de données ou un appel vocal. |
| FS_CALL_DELAYED | Le FSP a reçu un signal occupé plusieurs fois. Le fournisseur ne peut pas réessayer, car des restrictions de numérotation existent. (Certains pays/régions limitent le nombre de nouvelles tentatives lorsqu’un nombre est occupé.) |
| FS_USER_ABORT | Le FSP a annulé la transmission. L’annulation peut résulter d’un appel à la fonction FaxDevAbortOperation . Les fournisseurs de services de sécurité peuvent également fournir une interface utilisateur pour l’annulation des transmissions de télécopie. |
| FS_ANSWERED | Le FSP a répondu à l’appel entrant, mais ne reçoit pas encore l’appel. Cette status indique au service de télécopie que l’appel n’est peut-être pas un appel de télécopie. |
| FS_CALL_BLACKLISTED | Le FSP ne peut pas terminer l’appel parce que le numéro de téléphone est bloqué ou réservé, par exemple, un appel au 911 ou un autre numéro d’urgence. |
Les codes de status de télécopie FS_BAD_ADDRESS, FS_CALL_BLACKLISTED et FS_USER_ABORT n’entraînent aucune nouvelle tentative. Le code de status de télécopie FS_LINE_UNAVAILABLE entraîne une nouvelle tentative immédiate dans le cas où la ligne n’est pas disponible, car le service a perdu la connexion à l’appareil (TAPI envoyé LINE_CLOSE et le FSP signalé FS_LINE_UNAVAILABLE). La nouvelle tentative dépend de la détection ou non de l’appareil en ligne. Tous les autres codes de status de télécopie permettront au service de télécopie de gérer les nouvelles tentatives.
StringId
Type : DWORD
Spécifie un identificateur de ressource de chaîne pour le membre StatusId si le StatusId est défini par le fournisseur. Le service de télécopie charge la chaîne à partir de l’image du FSP. Si StatusId contient un code ou une valeur status défini par le fournisseur, ce membre est obligatoire. Si StatusId contient un code ou une valeur de status prédéfini, ce membre est ignoré.
PageCount
Type : DWORD
Spécifie le numéro de la page dans la transmission de télécopie que le FSP reçoit. Le nombre de pages est relatif à un.
CSI
Type : LPWSTR
Pointeur vers une chaîne de caractères Unicode terminée par null qui spécifie un identificateur du périphérique de télécopie distant connecté à l’appel actuel à la fonction FaxDevReceive ou FaxDevSend .
Si l’opération envoie une télécopie, l’identificateur spécifie le CSID de l’appareil distant ; si l’opération reçoit une télécopie, l’identificateur spécifie le TSID de l’appareil distant.
CallerId
Type : LPWSTR
Pointeur vers une chaîne de caractères Unicode terminée par null qui identifie l’appareil appelant qui a envoyé le document de télécopie reçu. Cette chaîne peut inclure le numéro de téléphone de l’appareil appelant.
RoutingInfo
Type : LPWSTR
Pointeur vers une chaîne de caractères Unicode terminée par null qui spécifie la chaîne de routage d’une télécopie entrante. La chaîne doit être de la forme suivante :
Canonical-Phone-Number[|Additional-Routing-Info]
où Canonical-Phone-Number est défini dans la rubrique Adresse de la documentation TAPI (voir le sous-texte Adresse canonique) ; et Additional-Routing-Info est la sous-adresse d’une adresse canonique et utilise le format de sous-adresse.
Pour le routage DID, ajoutez les chiffres DID spécifiques au préfixe de numéro de téléphone. L’adresse DID doit être le numéro de téléphone canonique qui correspond au numéro de téléphone complet que l’expéditeur aurait composé.
S’il existe des informations de routage supplémentaires, par exemple des tons de sous-adresse ou DTMF, séparez-les du numéro de téléphone canonique par un caractère de barre verticale, comme indiqué dans la spécification TAPI. Vous pouvez spécifier plusieurs destinataires.
Pour plus d’informations, consultez les sous-titres Adresse dialable et Adresse canonique dans la rubrique Adresse de la documentation TAPI.
ErrorCode
Type : DWORD
Spécifie l’un des codes d’erreur système Win32 [Base] que le FSP doit utiliser pour signaler une erreur qui se produit. Le FSP doit définir cette valeur sur NO_ERROR lorsqu’il est en cours d’exécution et une fois qu’un travail de télécopie s’est terminé normalement.
Reserved[3]
Type : DWORD
Ce membre est réservé par Microsoft. Il doit être défini sur zéro.
Remarques
Le FSP doit soit définir tous les membres de la structure FAX_DEV_STATUS sur les informations status pour l’opération de télécopie active, soit les définir sur zéro.
Le service de télécopie alloue la mémoire pour les chaînes pointées par les membres CSI, CallerId et RoutingInfo . La taille de la mémoire allouée par le service est égale à sizeof(FAX_DEV_STATUS) + FAXDEVREPORTSTATUS_SIZE. Le FSP doit placer les chaînes dans le bloc de mémoire qui suit immédiatement la structure FAX_DEV_STATUS . Les membres CSI, CallerId et RoutingInfo doivent pointer vers l’emplacement des chaînes dans le bloc de mémoire.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows 2000 Professionnel, Windows XP [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2003 [applications de bureau uniquement] |
| En-tête | faxdev.h |
Voir aussi
Structures des fournisseurs de services de télécopie
Utilisation de l’API du fournisseur de services de télécopie
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour