Fonction FaxGetPortA (winfax.h)

Article
08/27/2023

La fonction FaxGetPort retourne des informations pour un port de télécopie spécifié à une application cliente de télécopie. Les données incluent, entre autres éléments, l’identificateur de ligne permanent, la status et la capacité actuelles du port, ainsi que les identificateurs de station de transmission et appelés.

Syntaxe

WINFAXAPI BOOL FaxGetPortA(
  [in]  HANDLE          FaxPortHandle,
  [out] PFAX_PORT_INFOA *PortInfo
);

Paramètres

[in] FaxPortHandle

Type : HANDLE

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

[out] PortInfo

Type : PFAX_PORT_INFO*

Pointeur vers l’adresse d’une mémoire tampon pour recevoir une structure FAX_PORT_INFO . La structure décrit un port de télécopie. Pour plus d’informations sur l’allocation de mémoire, consultez la section Remarques suivante.

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_INVALID_PARAMETER	L’un ou les deux paramètres PortInfo ou FaxPortHandle sont NULL.
ERROR_ACCESS_DENIED	L’accès est refusé. FAX_PORT_QUERY accès est requis.
ERROR_NOT_ENOUGH_MEMORY	Une erreur s’est produite lors de l’allocation de mémoire.

Remarques

L’application doit appeler la fonction FaxOpenPort et spécifier le niveau d’accès PORT_OPEN_QUERY avant d’appeler la fonction FaxGetPort .

Une application d’administration de télécopie appelle généralement la fonction FaxGetPort pour interroger un appareil associé au serveur de télécopie.

Pour obtenir un handle de port valide à spécifier dans le paramètre FaxPortHandle , appelez la fonction FaxOpenPort .

La fonction FaxGetPort alloue la mémoire requise pour la mémoire tampon FAX_PORT_INFO pointée par le paramètre PortInfo . Une application doit appeler la fonction FaxFreeBuffer pour libérer les ressources associées à ce paramètre.

Pour plus d’informations, consultez Fax Gestion des appareils et Freeing Fax Resources.

Notes

L’en-tête winfax.h définit FaxGetPort 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