FaxGetJobA-Funktion (winfax.h)

Artikel
08/27/2023

Eine Faxclientanwendung ruft die FaxGetJob-Funktion auf, um detaillierte Informationen für den angegebenen in der Warteschlange angegebenen oder aktiven Faxauftrag abzurufen. Die Funktion gibt die Informationen in einer FAX_JOB_ENTRY-Struktur zurück.

Syntax

WINFAXAPI BOOL FaxGetJobA(
  [in]  HANDLE          FaxHandle,
  [in]  DWORD           JobId,
  [out] PFAX_JOB_ENTRYA *JobEntry
);

Parameter

[in] FaxHandle

Typ: HANDLE

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

[in] JobId

Art: DWORD

Gibt eine eindeutige Zahl an, die einen in der Warteschlange befindlichen oder aktiven Faxauftrag identifiziert. Der Auftrag kann eine eingehende oder eine ausgehende Übertragung sein.

[out] JobEntry

Typ: PFAX_JOB_ENTRY*

Zeiger auf die Adresse eines Puffers, um eine FAX_JOB_ENTRY-Struktur zu empfangen. Die Daten umfassen auftragstyp und status, Empfänger- und Absenderidentifikation, Planungs- und Übermittlungseinstellungen sowie die Seitenanzahl. 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_ACCESS_DENIED	Zugriff verweigert.“ FAX_JOB_QUERY Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER	Der JobId-Parameter ist ungültig, oder einer oder beide der JobEntry - oder FaxHandle-Parameter sind NULL.
ERROR_NOT_ENOUGH_MEMORY	Während der Speicherbelegung ist ein Fehler aufgetreten.

Hinweise

Die FaxGetJob-Funktion ruft Informationen zu einem einzelnen Faxauftrag ab. Rufen Sie die FaxEnumJobs-Funktion auf, um Informationen zu allen in der Warteschlange befindlichen und aktiven Aufträgen auf dem relevanten Faxserver abzurufen.

Die FaxGetJob-Funktion ordnet den Arbeitsspeicher zu, der für den Puffer erforderlich ist, auf den 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 Verwalten von Faxaufträgen und Freigeben von Faxressourcen.

Hinweis

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