FaxEnumJobsA-Funktion (winfax.h)

Artikel
08/27/2023

Die FaxEnumJobs-Funktion listet alle in der Warteschlange befindlichen und aktiven Faxaufträge auf dem Faxserver auf, mit dem der Client eine Verbindung hergestellt hat. Die Funktion gibt detaillierte Informationen für jeden Faxauftrag an die Faxclientanwendung zurück.

Syntax

WINFAXAPI BOOL FaxEnumJobsA(
  [in]  HANDLE          FaxHandle,
  [out] PFAX_JOB_ENTRYA *JobEntry,
  [out] LPDWORD         JobsReturned
);

Parameter

[in] FaxHandle

Typ: HANDLE

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

[out] JobEntry

Typ: PFAX_JOB_ENTRY*

Zeiger auf die Adresse eines Puffers, um ein Array von FAX_JOB_ENTRY Strukturen zu empfangen. Jede Struktur beschreibt einen Faxauftrag. Die Daten umfassen unter anderem den Auftragstyp und die status, empfänger- und absenderidentifikation, Planungs- und Übermittlungseinstellungen sowie die Seitenanzahl. Informationen zur Speicherbelegung finden Sie im folgenden Abschnitt hinweise.

[out] JobsReturned

Typ: LPDWORD

Zeiger auf eine DWORD-Variable , um die Anzahl der FAX_JOB_ENTRY Strukturen zu erhalten, die die Funktion im JobEntry-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	Der Zugriff wird verweigert. FAX_JOB_QUERY Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER	Einer oder alle der Parameter JobsReturned, JobEntry oder FaxHandle sind NULL.
ERROR_NOT_ENOUGH_MEMORY	Während der Speicherbelegung ist ein Fehler aufgetreten.

Hinweise

Die FaxEnumJobs-Funktion gibt eine Liste der Faxaufträge auf dem gewünschten Faxserver sowie Informationen zurück, die zu den einzelnen Aufträgen verfügbar sind. 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 FaxEnumJobs-Funktion weist den Arbeitsspeicher zu, der für das FAX_JOB_ENTRY Pufferarray erforderlich ist, auf das der JobEntry-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 Freigeben von Faxressourcen.

Hinweis

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


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