FaxGetLoggingCategories

The FaxGetLoggingCategories function returns to a fax client application the current logging categories for the fax server to which the client has connected. A logging category determines the errors or other events the fax server records in the application event log.

BOOL WINAPI FaxGetLoggingCategories(
  HANDLE FaxHandle,              // handle to the fax server
  PFAX_LOG_CATEGORY *Categories, // buffer to receive category data
  LPDWORD NumberCategories       // number of logging categories returned
);

Parameters

FaxHandle

[in] Specifies a fax server handle returned by a call to the FaxConnectFaxServer function.

Categories

[out] Pointer to the address of a buffer to receive an array of FAX_LOG_CATEGORY structures. Each structure describes one current logging category. The data includes the descriptive name of the logging category, the category number, and the current logging level.

For a description of predefined logging categories and logging levels, see the FAX_LOG_CATEGORY topic. For information about memory allocation, see the following Remarks section.

NumberCategories

[out] Pointer to a DWORD variable to receive the number of FAX_LOG_CATEGORY structures the function returns in the Categories parameter.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can return one of the following errors.

Remarks

A fax client application typically calls the FaxGetLoggingCategories function to query the current logging categories and logging levels for a fax server. To modify the current logging categories and levels, call the FaxSetLoggingCategories function.

The FaxGetLoggingCategories function allocates the memory required for the FAX_LOG_CATEGORY buffer array pointed to by the Categories parameter. An application must call the FaxFreeBuffer function to deallocate the resources associated with this parameter.

For more information, see Managing Logging Categories and Freeing Fax Resources.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable with BackOffice Small Business Server.
  Header: Declared in Winfax.h.
  Library: Included as a resource in Winfax.dll.
  Unicode: Implemented as Unicode and ANSI versions on all platforms.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Functions, FaxConnectFaxServer, FaxSetLoggingCategories, FaxFreeBuffer, FAX_LOG_CATEGORY