FaxGetLoggingCategoriesW-Funktion (winfax.h)

Artikel
11/20/2024

Die FaxGetLoggingCategories Funktion gibt an eine Faxclientanwendung die aktuellen Protokollierungskategorien für den Faxserver zurück, mit dem der Client verbunden ist. Eine Protokollierungskategorie bestimmt die Fehler oder andere Ereignisse, die der Faxserver im Anwendungsereignisprotokoll aufzeichnet.

Syntax

WINFAXAPI BOOL FaxGetLoggingCategoriesW(
  [in]  HANDLE             FaxHandle,
  [out] PFAX_LOG_CATEGORYW *Categories,
  [out] LPDWORD            NumberCategories
);

Parameter

[in] FaxHandle

Typ: HANDLE

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

[out] Categories

Typ: PFAX_LOG_CATEGORY*

Zeigen Sie auf die Adresse eines Puffers, um ein Array von FAX_LOG_CATEGORY Strukturen zu empfangen. Jede Struktur beschreibt eine aktuelle Protokollierungskategorie. Die Daten enthalten den beschreibenden Namen der Protokollierungskategorie, die Kategorienummer und die aktuelle Protokollierungsebene.

Eine Beschreibung der vordefinierten Protokollierungskategorien und Protokollierungsebenen finden Sie im thema FAX_LOG_CATEGORY. Informationen zur Speicherzuweisung finden Sie im folgenden Abschnitt "Hinweise".

[out] NumberCategories

Typ: LPDWORD-

Zeigen Sie auf eine DWORD- Variable, um die Anzahl der FAX_LOG_CATEGORY Strukturen zu erhalten, die die Funktion im parameter Categories zurückgibt.

Rückgabewert

Typ: BOOL-

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten. GetLastError kann einen der folgenden Fehler zurückgeben.

Rückgabecode	Beschreibung
ERROR_ACCESS_DENIED	Der Zugriff wurde verweigert. FAX_CONFIG_QUERY Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER	Mindestens einer der parameter Categories, NumberCategoriesoder FaxHandle Parameter sind NULL.
ERROR_NOT_ENOUGH_MEMORY	Fehler bei der Speicherzuweisung.

Bemerkungen

Eine Faxclientanwendung ruft in der Regel die FaxGetLoggingCategories Funktion auf, um die aktuellen Protokollierungskategorien und Protokollierungsebenen für einen Faxserver abzufragen. Rufen Sie zum Ändern der aktuellen Protokollierungskategorien und -ebenen die FaxSetLoggingCategories-Funktion auf.

Die FaxGetLoggingCategories--Funktion weist den für das FAX_LOG_CATEGORY Pufferarray erforderlichen Speicher zu, auf den der Categories Parameter verweist. Eine Anwendung muss die FaxFreeBuffer--Funktion aufrufen, um die diesem Parameter zugeordneten Ressourcen zuzuordnen.

Weitere Informationen finden Sie unter Verwalten von Protokollierungskategorien und Freigeben von Faxressourcen.

Anmerkung

Der winfax.h-Header definiert FaxGetLoggingCategories als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winfax.h
Library	WinFax.lib