FaxSetPortA-Funktion (winfax.h)

Artikel
03/13/2024

Eine Faxclientanwendung ruft die FaxSetPort-Funktion auf, um die Konfiguration des gewünschten Faxports zu ändern. Die Konfigurationsdaten können unter anderem die Funktion des Ports, seine Priorität, Ringe vor der Antwort und die übertragenden und aufgerufenen Stationsbezeichner umfassen.

Syntax

WINFAXAPI BOOL FaxSetPortA(
  [in] HANDLE               FaxPortHandle,
  [in] const FAX_PORT_INFOA *PortInfo
);

Parameter

[in] FaxPortHandle

Typ: HANDLE

Gibt ein Faxporthandle an, das von einem Aufruf der FaxOpenPort-Funktion zurückgegeben wird.

[in] PortInfo

Typ: const FAX_PORT_INFO*

Zeiger auf eine FAX_PORT_INFO-Struktur . Die -Struktur enthält Daten zum Ändern der Konfiguration des angegebenen Faxports.

Rückgabewert

Typ: BOOL

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf. GetLastError kann einen der folgenden Fehler zurückgeben.

Rückgabecode	Beschreibung
ERROR_ACCESS_DENIED	Zugriff verweigert.“ FAX_PORT_SET Zugriff ist erforderlich.
ERROR_DEVICE_IN_USE	Der durch den Parameter FaxPortHandle angegebene Port ist ausgelastet.
ERROR_INVALID_PARAMETER	Einer oder beide der Parameter FaxPortHandle oder PortInfo sind NULL.

Hinweise

Die Anwendung muss die FaxOpenPort-Funktion aufrufen und die PORT_OPEN_MODIFY Zugriffsebene angeben, bevor die FaxSetPort-Funktion aufgerufen wird.

Mit dieser Funktion können nur die folgenden Member der FAX_PORT_INFO-Struktur festgelegt werden: Flags, Rings, Priority, Tsid und Csid

Eine Faxverwaltungsanwendung ruft in der Regel die FaxSetPort-Funktion auf, um die Faxgeräte zu verwalten, die dem Faxserver zugeordnet sind. Rufen Sie die FaxGetPort-Funktion auf, um die Geräte abzufragen.

Um ein gültiges Porthandle zu erhalten, das im FaxPortHandle-Parameter der FaxSetPort-Funktion angegeben werden soll, rufen Sie die FaxOpenPort-Funktion auf. Weitere Informationen finden Sie unter Fax Geräteverwaltung.

Hinweis

Der winfax.h-Header definiert FaxSetPort als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winfax.h
Bibliothek	WinFax.lib