FaxCompleteJobParamsA-Funktion (winfax.h)

Artikel
03/04/2024

Die FaxCompleteJobParams-Funktion erstellt sowohl eine FAX_COVERPAGE_INFO-Struktur als auch eine FAX_JOB_PARAM-Struktur für eine Faxclientanwendung. Diese Hilfsfunktion stellt mehrere Member dieser Strukturen mit Werten für die Größe der Struktur, den Namen des Absenders und optionale Abrechnungscodeinformationen bereit.

Syntax

WINFAXAPI BOOL FaxCompleteJobParamsA(
  [in, out] PFAX_JOB_PARAMA      *JobParams,
  [in, out] PFAX_COVERPAGE_INFOA *CoverpageInfo
);

Parameter

[in, out] JobParams

Typ: PFAX_JOB_PARAM*

Zeiger auf die Adresse eines Puffers, der eine FAX_JOB_PARAM-Struktur enthält. Bei der Ausgabe enthält diese Struktur Member mit Werten, die vom Faxserver verfügbar sind.

[in, out] CoverpageInfo

Typ: PFAX_COVERPAGE_INFO*

Zeiger auf die Adresse eines Puffers, der eine FAX_COVERPAGE_INFO-Struktur enthält. Bei der Ausgabe enthält diese Struktur Member mit Werten, die vom Faxserver verfügbar sind.

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.

Hinweise

Die Faxclientanwendung sollte die FaxCompleteJobParams-Funktion aufrufen, bevor die FaxSendDocument-Funktion aufgerufen wird. Dadurch kann der Faxserver alle Werte bereitstellen, die für die Member der FAX_JOB_PARAM und der FAX_COVERPAGE_INFO-Strukturen verfügbar sind. Die Anwendung sollte diese Informationen nicht in der Registrierung des Benutzers abfragen, da sich der Speicherort der Informationen ändern kann. Weitere Informationen finden Sie unter Übertragen von Faxen.

Die Anwendung muss die FaxFreeBuffer-Funktion einmal aufrufen, um die Zuordnung des Puffers aufzugeben, auf den der JobParams-Parameter verweist, und erneut, um die Zuordnung des Puffers aufzugeben, auf den der CoverpageInfo-Parameter verweist. Weitere Informationen finden Sie unter Freigeben von Faxressourcen.

Hinweis

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