FaxGetConfigurationA-Funktion (winfax.h)

Artikel
03/04/2024

Die FaxGetConfiguration-Funktion gibt die globalen Konfigurationseinstellungen für den Faxserver, mit dem der Client verbunden ist, an eine Faxclientanwendung zurück. Die Daten umfassen u. a. Die Einstellungen für die Erneute Übertragung, das Branding, das Archiv und die Deckblatteinstellungen; Perioden des Abzinsungssatzes; und die status der Faxserverwarteschlange.

Syntax

WINFAXAPI BOOL FaxGetConfigurationA(
  [in]  HANDLE              FaxHandle,
  [out] PFAX_CONFIGURATIONA *FaxConfig
);

Parameter

[in] FaxHandle

Typ: HANDLE

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

[out] FaxConfig

Typ: PFAX_CONFIGURATION*

Zeiger auf die Adresse eines Puffers, um eine FAX_CONFIGURATION Struktur zu empfangen. Die Struktur enthält die aktuellen Konfigurationseinstellungen für den Faxserver. Informationen zur Speicherzuordnung finden Sie im folgenden Abschnitt mit den Anmerkungen.

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_INVALID_PARAMETER	Ein oder beide Parameter FaxConfig oder FaxHandle sind NULL.
ERROR_ACCESS_DENIED	Zugriff verweigert.“ FAX_CONFIG_QUERY Zugriff ist erforderlich.
ERROR_NOT_ENOUGH_MEMORY	Während der Speicherzuordnung ist ein Fehler aufgetreten.

Hinweise

Eine Faxverwaltungsanwendung ruft in der Regel die FaxGetConfiguration-Funktion auf, um die globalen Konfigurationseinstellungen für den Faxserver anzuzeigen. Um die Konfigurationseinstellungen zu ändern, rufen Sie die FaxSetConfiguration-Funktion auf .

Die FaxGetConfiguration-Funktion weist den Speicher zu, der für den FAX_CONFIGURATION Puffer benötigt wird, auf den der FaxConfig-Parameter verweist. Eine Anwendung muss die FaxFreeBuffer-Funktion aufrufen, um die Zuordnung der Ressourcen zu beheben, die diesem Parameter zugeordnet sind.

Weitere Informationen finden Sie unter Verwaltung der Faxserverkonfiguration und Freigeben von Faxressourcen.

Hinweis

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