2.2.11 FAX_LOG_CATEGORY

  • Article

The FAX_LOG_CATEGORY structure describes one logging category. Each logging category is identified by a numeric identifier and is described by a user-friendly name. The fax server associates with each logging category a configurable severity-level threshold that controls which logged events will cause entries to be written to the event log. If the current severity-level threshold for the event's category is lower than the event's severity level, the fax server SHOULD NOT write a corresponding entry into the log. The fax client application passes an array of FAX_LOG_CATEGORY structures in a call to the FAX_SetLoggingCategories (section 3.1.4.1.83) function to modify the current logging categories for the fax server of interest. The FAX_GetLoggingCategories (section 3.1.4.1.44) function returns the current settings in an array of FAX_LOG_CATEGORY structures.

An array of this structure is sent as an input argument for the FaxObs_SetLoggingCategories (section 3.1.4.2.27) method, and this structure is sent as an output parameter for the FaxObs_GetLoggingCategories (section 3.1.4.2.26) method.

This data structure is custom marshaled as follows and uses the custom-marshaling rules defined in section 2.2.1.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Fixed_Portion

...

...

Variable_Data (variable)

...

Fixed_Portion (12 bytes):


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

NameOffset

Category

Level

NameOffset (4 bytes): Offset to the Name field in the Variable_Data portion of the structure

Category (4 bytes): A DWORD ([MS-DTYP] section 2.2.9) that holds a unique value that identifies a logging category for the events the fax server writes. Each event to be written by the fax server SHOULD have a logging category preassigned to it. The fax server SHOULD write the respective logging category when writing an event, so that the accumulated events could be organized by the administrator by using the logging categories. This field MUST be one of the following predefined values.<4>

Value/code

Meaning

FAXLOG_CATEGORY_INIT

1

A fax service initialization or termination event.

FAXLOG_CATEGORY_OUTBOUND

2

An outgoing fax transmission event such as sending a fax.

FAXLOG_CATEGORY_INBOUND

3

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

FAXLOG_CATEGORY_UNKNOWN

4

An unknown event.

Level (4 bytes): A DWORD that holds the current severity-level threshold for the logging category identified by Category. If the current severity-level threshold for the event's category is lower than the event's severity level, the fax server SHOULD NOT write a corresponding entry into the log. This field MUST contain one of the following predefined severity-level values.

Value/code

Meaning

FAXLOG_LEVEL_NONE

0

The fax server MUST NOT log events.

FAXLOG_LEVEL_MIN

1

The fax server SHOULD log only the most severe failure events.

FAXLOG_LEVEL_MED

2

The fax server SHOULD log most events (this level does not include some informational and warning events).

FAXLOG_LEVEL_MAX

3

The fax server MUST log all events.

Variable_Data (variable):


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Name (variable)

...

Name (variable): A null-terminated character string that contains the name for the logging category.