structure FAX_PORT_INFOW (winfax.h)
La structure FAX_PORT_INFO décrit un port de télécopie. Les données incluent, entre autres éléments, un identificateur d’appareil, le nom du port et l’état actuel et les identificateurs de station.
Syntaxe
typedef struct _FAX_PORT_INFOW {
DWORD SizeOfStruct;
DWORD DeviceId;
DWORD State;
DWORD Flags;
DWORD Rings;
DWORD Priority;
LPCWSTR DeviceName;
LPCWSTR Tsid;
LPCWSTR Csid;
} FAX_PORT_INFOW, *PFAX_PORT_INFOW;
Membres
SizeOfStruct
Type : DWORD
Spécifie la taille, en octets, de la structure FAX_PORT_INFO . L’application appelante doit s’assurer que ce membre est défini sur sizeof(FAX_PORT_INFO) avant d’appeler la fonction FaxSetPort .
DeviceId
Type : DWORD
Spécifie une variable DWORD qui indique l’identificateur de ligne permanent pour l’appareil de télécopie d’intérêt.
State
Type : DWORD
Spécifie une variable DWORD qui est un code ou une valeur d’état de l’appareil de télécopie. Ce membre peut être l’un des codes d’état de l’appareil prédéfinis indiqués ci-dessous.
FPS_DIALING
L’appareil compose un numéro de télécopie.
FPS_SENDING
L’appareil envoie un document de télécopie.
FPS_RECEIVING
L’appareil reçoit un document de télécopie.
FPS_COMPLETED
L’appareil a terminé l’envoi ou la réception d’une transmission de télécopie.
FPS_UNAVAILABLE
L’appareil n’est pas disponible, car il est utilisé par une autre application.
FPS_BUSY
L’appareil a rencontré un signal occupé.
FPS_NO_ANSWER
L’appareil de réception n’a pas répondu à l’appel.
FPS_BAD_ADDRESS
L’appareil a composé un numéro de télécopie non valide.
FPS_NO_DIAL_TONE
L’appareil d’envoi ne peut pas terminer l’appel, car il ne détecte pas de ton de numérotation.
FPS_DISCONNECTED
L’appel de télécopie a été déconnecté par l’expéditeur ou l’appelant.
FPS_FATAL_ERROR
L’appareil a rencontré une erreur de protocole irrécupérable.
FPS_NOT_FAX_CALL
L’appareil a reçu un appel de données ou un appel vocal.
FPS_CALL_DELAYED
L’appareil a retardé un appel de télécopie, car l’appareil d’envoi a reçu un signal occupé plusieurs fois. L’appareil ne peut pas réessayer l’appel, car les restrictions de numérotation existent. (Certains pays/régions limitent le nombre de tentatives de nouvelle tentative lorsqu’un nombre est occupé.)
FPS_CALL_BLACKLISTED
L’appareil n’a pas pu terminer un appel, car le numéro de téléphone a été bloqué ou réservé; les numéros d’urgence tels que 911 sont bloqués.
FPS_INITIALIZING
L’appareil initialise un appel.
FPS_OFFLINE
L’appareil est hors connexion et indisponible.
FPS_RINGING
L’appareil sonne.
FPS_AVAILABLE
L’appareil est disponible.
FPS_ABORTING
L’appareil a abandonné une tâche de télécopie.
FPS_ROUTING
L’appareil effectue le routage d’un document de télécopie reçu.
FPS_ANSWERED
L’appareil a répondu à un nouvel appel.
FPS_HANDLED
Le service de télécopie a traité le document de télécopie sortant ; le fournisseur de services de télécopie transmet le document.
Flags
Type : DWORD
Spécifie une variable DWORD qui est un ensemble d’indicateurs de bits qui spécifient la capacité du port de télécopie. Ce membre peut être une combinaison des valeurs suivantes.
FPF_RECEIVE
L’appareil peut recevoir des télécopies.
FPF_SEND
L’appareil peut envoyer des télécopies.
FPF_VIRTUAL
L’appareil est un appareil de télécopie virtuel. Pour plus d’informations, consultez Appareils de télécopie virtuelle. Notez que vous ne pouvez pas définir un appareil comme virtuel. Lors de l’appel de FaxGetPort, la valeur FPF_VIRTUAL de l’indicateur FAX_PORT_INFO indique si l’appareil est virtuel. Lors de l’appel de FaxSetPort, le service n’est lié qu’aux valeurs FPF_RECEIVE et FPF_SEND .
Rings
Type : DWORD
Spécifie une variable DWORD qui indique le nombre de fois où un appel de télécopie entrant doit sonner avant que l’appareil spécifié répond à l’appel. Les valeurs possibles sont comprises entre 0 et 99 inclus. Cette valeur est ignorée, sauf si l’indicateur de bit de capacité de port FPF_RECEIVE est défini.
Priority
Type : DWORD
Spécifie une variable DWORD qui détermine l’ordre relatif dans lequel les appareils de télécopie disponibles envoient des transmissions sortantes. Les valeurs valides pour ce membre sont 1 à n, où n est la valeur du paramètre PortsReturned retourné par un appel à la fonction FaxEnumPorts .
Lorsque le serveur de télécopie lance une transmission de télécopie sortante, il tente de sélectionner l’appareil avec la priorité la plus élevée et FPF_SEND capacité de port. Si cet appareil n’est pas disponible, le serveur sélectionne l’appareil disponible suivant dans l’ordre de classement, et ainsi de suite. La valeur du membre Priority n’a aucun effet sur les transmissions entrantes.
DeviceName
Type : LPCTSTR
Pointeur vers une chaîne de caractères arrêtée par null constante qui spécifie le nom de l’appareil de télécopie d’intérêt.
Tsid
Type : LPCTSTR
Pointeur vers une chaîne de caractères arrêtée par null constante qui spécifie la TSID. Cet identificateur est généralement un numéro de téléphone. Seuls les caractères imprimables tels que les lettres anglaises, les symboles numériques et les marques de ponctuation (plage ASCII 0x20 à 0x7F) peuvent être utilisés dans une TSID.
Csid
Type : LPCTSTR
Pointeur vers une chaîne de caractères arrêtée par null constante qui spécifie l’identificateur de station appelé (CSID). Cet identificateur est généralement un numéro de téléphone. Seuls les caractères imprimables tels que les lettres anglaises, les symboles numériques et les marques de ponctuation (plage ASCII 0x20 à 0x7F) peuvent être utilisés dans un CSID.
Notes
Une application cliente de télécopie transmet la structure FAX_PORT_INFO dans un appel à la fonction FaxSetPort pour modifier la configuration du port de télécopie d’intérêt.
Si une application appelle la fonction FaxEnumPorts pour énumérer tous les appareils de télécopie actuellement attachés à un serveur de télécopie, la fonction retourne un tableau de structures FAX_PORT_INFO . Chaque structure décrit un appareil en détail. Si une application appelle la fonction FaxGetPort pour interroger un appareil, cette fonction retourne des informations sur l’appareil dans une structure FAX_PORT_INFO . Pour plus d’informations, consultez Les ports de télécopie et les Gestion des appareils de télécopie.
Notes
L’en-tête winfax.h définit FAX_PORT_INFO en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Configuration requise
| Client minimal pris en charge | Windows 2000 Professionnel [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows 2000 Server [applications de bureau uniquement] |
| En-tête | winfax.h |
Voir aussi
Structures de l’API cliente du service de télécopie