FaxEnumPortsA-Funktion (winfax.h)

Artikel
03/09/2024

Die FaxEnumPorts-Funktion listet alle Faxgeräte auf, die derzeit an den Faxserver angeschlossen sind, mit dem der Client verbunden ist. Die Funktion gibt detaillierte Informationen für jeden Faxport an die Faxclientanwendung zurück.

Syntax

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

Parameter

[in] FaxHandle

Typ: HANDLE

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

[out] PortInfo

Typ: PFAX_PORT_INFO*

Zeiger auf die Adresse eines Puffers, um ein Array von FAX_PORT_INFO Strukturen zu empfangen. Jede Struktur beschreibt einen Faxport. Die Daten umfassen unter anderem den permanenten Zeilenbezeichner und die aktuelle status und -funktion des Ports. Informationen zur Speicherzuordnung finden Sie im folgenden Abschnitt mit den Anmerkungen.

[out] PortsReturned

Typ: LPDWORD

Zeiger auf eine DWORD-Variable , um die Anzahl der FAX_PORT_INFO Strukturen zu erhalten, die die Funktion im PortInfo-Parameter zurückgibt.

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_JOB_QUERY Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER	Mindestens einer der PortsReturned-, PortInfo- oder FaxHandle-Parameter ist NULL.
ERROR_NOT_ENOUGH_MEMORY	Während der Speicherzuordnung ist ein Fehler aufgetreten.

Hinweise

Die FaxEnumPorts-Funktion gibt eine Liste von Faxaufträgen auf dem gewünschten Faxserver sowie informationen zu den einzelnen Aufträgen zurück. Eine Faxverwaltungsanwendung ruft diese Funktion in der Regel auf, um die Faxauftragswarteschlange zu Verwaltungs- oder Abfragezwecken anzuzeigen. Weitere Informationen finden Sie unter Verwalten von Faxaufträgen.

Die FaxEnumPorts-Funktion weist den Speicher zu, der für das FAX_JOB_ENTRY Pufferarray benötigt wird, auf das der JobEntry-Parameter verweist. Eine Anwendung muss die FaxFreeBuffer-Funktion aufrufen, um die Zuordnung der Ressourcen zu beheben, die diesem Parameter zugeordnet sind. Weitere Informationen finden Sie unter Freigeben von Faxressourcen.

Hinweis

Der winfax.h-Header definiert FaxEnumPorts 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 nicht codierungsneutralem Code 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