FaxSetConfigurationA-Funktion (winfax.h)

Artikel
03/04/2024

Eine Faxclientanwendung ruft die FaxSetConfiguration-Funktion auf, um die globalen Konfigurationseinstellungen für den Faxserver zu ändern, mit dem der Client verbunden ist. Die Konfigurationsdaten können unter anderem Einstellungen für die Erneute Übertragung, Branding, Archiv und Deckblatt umfassen. Perioden des Abzinsungssatzes; und die status der Faxserverwarteschlange.

Syntax

WINFAXAPI BOOL FaxSetConfigurationA(
  [in] HANDLE                   FaxHandle,
  [in] const FAX_CONFIGURATIONA *FaxConfig
);

Parameter

[in] FaxHandle

Typ: HANDLE

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

[in] FaxConfig

Typ: const FAX_CONFIGURATION*

Zeiger auf eine FAX_CONFIGURATION-Struktur . Die Struktur enthält Daten zum Ändern der aktuellen Faxserverkonfigurationseinstellungen.

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_CONFIG_SET Zugriff ist erforderlich.
ERROR_ACCESS_DENIED	Zugriff verweigert.“ FAX_PORT_QUERY Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER	Der FaxConfig-Parameter ist NULL, oder das SizeOfStruct-Element der angegebenen FAX_CONFIGURATION-Struktur ist nicht gleich sizeof(FAX_CONFIGURATION).

Hinweise

Eine Faxverwaltungsanwendung ruft in der Regel die FaxSetConfiguration-Funktion auf, um die globalen Konfigurationseinstellungen für einen Faxserver zu verwalten. Zum Abfragen der Einstellungen kann eine Anwendung die FaxGetConfiguration-Funktion aufrufen. Weitere Informationen finden Sie unter Konfigurationsverwaltung für Faxserver.

Hinweis

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

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