Fonction FaxSetPortA (winfax.h)

Article
08/27/2023

Une application cliente de télécopie appelle la fonction FaxSetPort pour modifier la configuration du port de télécopie d’intérêt. Les données de configuration peuvent inclure, entre autres éléments, la capacité du port, sa priorité, les anneaux avant la réponse et les identificateurs de station de transmission et appelés.

Syntaxe

WINFAXAPI BOOL FaxSetPortA(
  [in] HANDLE               FaxPortHandle,
  [in] const FAX_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 .

[in] PortInfo

Type : const FAX_PORT_INFO*

Pointeur vers une structure FAX_PORT_INFO . La structure contient des données permettant de modifier la configuration du port de télécopie spécifié.

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_PORT_SET accès est requis.
ERROR_DEVICE_IN_USE	Le port indiqué par le paramètre FaxPortHandle est occupé.
ERROR_INVALID_PARAMETER	L’un ou les deux paramètres FaxPortHandle ou PortInfo sont NULL.

Remarques

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

Seuls les membres suivants de la structure FAX_PORT_INFO peuvent être définis à l’aide de cette fonction : Flags, Rings, Priority, Tsid et Csid

Une application d’administration de télécopie appelle généralement la fonction FaxSetPort pour administrer les périphériques de télécopie associés au serveur de télécopie. Pour interroger les appareils, appelez la fonction FaxGetPort .

Pour obtenir un handle de port valide à spécifier dans le paramètre FaxPortHandle de la fonction FaxSetPort , appelez la fonction FaxOpenPort . Pour plus d’informations, consultez Télécopie Gestion des appareils.

Notes

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