FaxSetJobA-Funktion (winfax.h)

Artikel
08/27/2023

Eine Faxclientanwendung ruft die FaxSetJob-Funktion auf, um einen angegebenen Faxauftrag anzuhalten, fortzusetzen, abzubrechen oder neu zu starten.

Syntax

WINFAXAPI BOOL FaxSetJobA(
  [in] HANDLE               FaxHandle,
  [in] DWORD                JobId,
  [in] DWORD                Command,
  [in] const FAX_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 DWORD-Variable an, die eine eindeutige Zahl ist, um den zu ändernden Faxauftrag zu identifizieren. Rufen Sie die FaxEnumJobs-Funktion auf, um einen gültigen Faxauftragsbezeichner abzurufen, der im JobId-Parameter verwendet werden soll.

[in] Command

Art: DWORD

Gibt eine DWORD-Variable an, die den auszuführenden Auftragsbefehl angibt. Dieser Parameter kann einen der folgenden Werte annehmen.

JC_DELETE

Brechen Sie den angegebenen Faxauftrag ab. Der Auftrag kann aktiv oder in der Warteschlange sein.

JC_PAUSE

Halten Sie den angegebenen Faxauftrag in der Warteschlange an. Wenn der Faxauftrag aktiv ist, hält der Faxdienst den Auftrag an, wenn er in den Zustand der Warteschlange zurückkehrt.

JC_RESUME

Setzen Sie den angehaltenen Faxauftrag fort.

JC_RESTART

Starten Sie den angegebenen Faxauftrag neu.

[in] JobEntry

Typ: const FAX_JOB_ENTRY*

Nicht verwendet, muss NULL sein.

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_MANAGE Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER	Der FaxHandle-Parameter ist NULL, oder einer oder alle Der Parameter Command, JobEntry oder JobId sind ungültig.

Hinweise

Eine Anwendung ruft in der Regel die FaxSetJob-Funktion auf, um einen Faxauftrag in der Warteschlange zu verwalten. Um eine derzeit laufende Faxübertragung zu beenden, kann eine Anwendung die FaxAbort-Funktion aufrufen.

Weitere Informationen finden Sie unter Ändern eines Faxauftrags und Beenden eines Faxauftrags.

Hinweis

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


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