FaxGetPortA-Funktion (winfax.h)

Artikel
08/27/2023

Die FaxGetPort-Funktion gibt Informationen für einen angegebenen Faxport an eine Faxclientanwendung zurück. Die Daten umfassen unter anderem den permanenten Zeilenbezeichner, den aktuellen status und die Funktion des Ports sowie die übertragenden und aufgerufenen Stationsbezeichner.

Syntax

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

Parameter

[in] FaxPortHandle

Typ: HANDLE

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

[out] PortInfo

Typ: PFAX_PORT_INFO*

Zeiger auf die Adresse eines Puffers, um eine FAX_PORT_INFO-Struktur zu empfangen. Die Struktur beschreibt einen Faxport. Informationen zur Speicherbelegung finden Sie im folgenden Abschnitt hinweise.

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_INVALID_PARAMETER	Einer oder beide Der PortInfo - oder FaxPortHandle-Parameter sind NULL.
ERROR_ACCESS_DENIED	Zugriff verweigert.“ FAX_PORT_QUERY Zugriff ist erforderlich.
ERROR_NOT_ENOUGH_MEMORY	Während der Speicherbelegung ist ein Fehler aufgetreten.

Hinweise

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

Eine Faxverwaltungsanwendung ruft in der Regel die FaxGetPort-Funktion auf, um ein Gerät abzufragen, das dem Faxserver zugeordnet ist.

Um ein gültiges Porthandle zu erhalten, das im Parameter FaxPortHandle angegeben werden soll, rufen Sie die FaxOpenPort-Funktion auf.

Die FaxGetPort-Funktion ordnet den Arbeitsspeicher zu, der für den FAX_PORT_INFO Puffer benötigt wird, auf den der PortInfo-Parameter verweist. Eine Anwendung muss die FaxFreeBuffer-Funktion aufrufen, um die Zuordnung der ressourcen, die diesem Parameter zugeordnet sind, aufzugeben.

Weitere Informationen finden Sie unter Fax Geräteverwaltung und Freigeben von Faxressourcen.

Hinweis

Der winfax.h-Header definiert FaxGetPort 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