Fonction FaxEnumPortsA (winfax.h)

Article
03/13/2024

La fonction FaxEnumPorts énumère tous les périphériques de télécopie actuellement attachés au serveur de télécopie auquel le client s’est connecté. La fonction retourne des informations détaillées pour chaque port de télécopie à l’application cliente de télécopie.

Syntaxe

WINFAXAPI BOOL FaxEnumPortsA(
  [in]  HANDLE          FaxHandle,
  [out] PFAX_PORT_INFOA *PortInfo,
  [out] LPDWORD         PortsReturned
);

Paramètres

[in] FaxHandle

Type : HANDLE

Spécifie un handle de serveur de télécopie retourné par un appel à la fonction FaxConnectFaxServer .

[out] PortInfo

Type : PFAX_PORT_INFO*

Pointeur vers l’adresse d’une mémoire tampon pour recevoir un tableau de structures FAX_PORT_INFO . Chaque structure décrit un port de télécopie. Les données incluent, entre autres éléments, l’identificateur de ligne permanent, ainsi que la status et la fonctionnalité actuelles du port. Pour plus d’informations sur l’allocation de mémoire, consultez la section Remarques suivante.

[out] PortsReturned

Type : LPDWORD

Pointeur vers une variable DWORD pour recevoir le nombre de structures FAX_PORT_INFO que la fonction retourne dans le paramètre PortInfo .

Valeur retournée

Type : BOOL

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. GetLastError peut retourner l’une des erreurs suivantes.

Code de retour	Description
ERROR_ACCESS_DENIED	L’accès est refusé. FAX_JOB_QUERY accès est requis.
ERROR_INVALID_PARAMETER	Un ou tous les paramètres PortsReturned, PortInfo ou FaxHandle ont la valeur NULL.
ERROR_NOT_ENOUGH_MEMORY	Une erreur s’est produite lors de l’allocation de mémoire.

Remarques

La fonction FaxEnumPorts retourne une liste des travaux de télécopie sur le serveur de télécopie qui vous intéresse, ainsi que les informations disponibles sur chaque travail. Une application d’administration de télécopie appelle généralement cette fonction pour afficher la file d’attente des travaux de télécopie à des fins administratives ou de requête. Pour plus d’informations, consultez Gestion des travaux de télécopie.

La fonction FaxEnumPorts alloue la mémoire requise pour le tableau de mémoires tampons FAX_JOB_ENTRY pointé par le paramètre JobEntry . Une application doit appeler la fonction FaxFreeBuffer pour libérer les ressources associées à ce paramètre. Pour plus d’informations, consultez Libérer des ressources de télécopie.

Notes

L’en-tête winfax.h définit FaxEnumPorts comme un 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. Le mélange 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

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winfax.h
Bibliothèque	WinFax.lib