FAX_LOG_CATEGORYA structure (winfax.h)

Article
07/27/2022

The FAX_LOG_CATEGORY structure describes one logging category. The structure contains a logging category name and identifier. It also includes the current level at which the fax server logs events for the specified logging category in the application event log.

Syntax

typedef struct _FAX_LOG_CATEGORYA {
  LPCSTR Name;
  DWORD  Category;
  DWORD  Level;
} FAX_LOG_CATEGORYA, *PFAX_LOG_CATEGORYA;

Members

Name

Type: LPCTSTR

Pointer to a constant null-terminated character string that is a descriptive name for the logging category.

Category

Type: DWORD

Specifies a DWORD variable that is a unique value that identifies a logging category. This member can be one of the following predefined values.

FAXLOG_CATEGORY_INIT

A fax service initialization or termination event.

FAXLOG_CATEGORY_OUTBOUND

An outgoing fax transmission event such as sending a fax.

FAXLOG_CATEGORY_INBOUND

An incoming fax transmission event such as receiving a fax or routing a fax.

FAXLOG_CATEGORY_UNKNOWN

An unknown event.

Level

Type: DWORD

Specifies a DWORD variable that indicates the current logging level for the logging category. This member can be one of the following predefined logging levels.

FAXLOG_LEVEL_NONE

The fax server does not log events.

FAXLOG_LEVEL_MIN

The fax server logs only the most severe failure events.

FAXLOG_LEVEL_MED

The fax server logs most events. (This level does not include some informational and warning events.)

FAXLOG_LEVEL_MAX

The fax server logs all events.

Remarks

The fax client application passes the FAX_LOG_CATEGORY structure in a call to the FaxSetLoggingCategories function to modify the current logging categories for the fax server of interest. If the application calls the FaxGetLoggingCategories function, it returns the current settings in a FAX_LOG_CATEGORY structure. For more information, see Managing Logging Categories.

Note

The winfax.h header defines FAX_LOG_CATEGORY as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	winfax.h