FaxEnumJobsW-Funktion (winfax.h)

2024-11-20

Die FaxEnumJobs Funktion listet alle in die Warteschlange gestellten und aktiven Faxaufträge auf dem Faxserver auf, mit dem der Client verbunden ist. Die Funktion gibt detaillierte Informationen für jeden Faxauftrag an die Faxclientanwendung zurück.

Syntax

WINFAXAPI BOOL FaxEnumJobsW(
  [in]  HANDLE          FaxHandle,
  [out] PFAX_JOB_ENTRYW *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*

Zeigen Sie 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 den Status; Empfänger- und Absenderidentifikation; Planungs- und Übermittlungseinstellungen; und die Seitenanzahl. Informationen zur Speicherzuweisung 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 fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten. GetLastError kann einen der folgenden Fehler zurückgeben.

Rückgabecode	Beschreibung
ERROR_ACCESS_DENIED	Der Zugriff wurde verweigert. FAX_JOB_QUERY Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER	Einer oder alle JobsReturned, JobEntryoder FaxHandle Parameter sind NULL.
ERROR_NOT_ENOUGH_MEMORY	Fehler bei der Speicherzuweisung.

Bemerkungen

Die FaxEnumJobs Funktion gibt eine Liste von Faxaufträgen auf dem Faxserver von Interesse sowie Informationen zu den einzelnen Stellen zurück. Eine Faxverwaltungsanwendung ruft diese Funktion in der Regel auf, um die Faxauftragswarteschlange für administrative oder Abfragezwecke anzuzeigen. Weitere Informationen finden Sie unter Verwalten von Faxaufträgen.

Die FaxEnumJobs--Funktion weist den für das FAX_JOB_ENTRY Pufferarray erforderlichen Speicher zu, auf den der JobEntry-Parameter verweist. Eine Anwendung muss die FaxFreeBuffer--Funktion aufrufen, um die diesem Parameter zugeordneten Ressourcen zuzuordnen. Weitere Informationen finden Sie unter Freigeben von Faxressourcen.

Anmerkung

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

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winfax.h
Library	WinFax.lib