3.1.4.2.26 FaxObs_GetLoggingCategories (Opnum 24)

The FaxObs_GetLoggingCategories (Opnum 24) method is called by the client to retrieve the current logging categories from the server. A logging category determines the errors or other events that the fax server records in the application event log.

In response, the server MUST return the current logging categories.

The client SHOULD free the returned buffer.

 error_status_t FaxObs_GetLoggingCategories(
   [in] handle_t hBinding,
   [in, out, unique, size_is(,*BufferSize)] 
     LPBYTE* Buffer,
   [in, out] LPDWORD BufferSize,
   [in, out] LPDWORD NumberCategories
 );

hBinding: The RPC binding handle for this call. The client SHOULD reuse the RPC binding handle used as an input hBinding argument for the FaxObs_ConnectionRefCount (section 3.1.4.2.2) method call used to connect to the fax server.

Buffer: A pointer to the address of the returned buffer containing an array of FAX_LOG_CATEGORY (section 2.2.11) structures. The number of structures included in the array is set by NumberCategories. Each structure describes one current logging category. The Name strings are appended after the FAX_LOG_CATEGORY entries.

BufferSize: A variable to return the size, in bytes, of the buffer.

NumberCategories: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable to receive the number of FAX_LOG_CATEGORY structures that the method returns in the Buffer parameter.

Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise, it MUST return one of the following error codes, one of the fax-specific errors that are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF] section 2.2.

Return value/code	Description
ERROR_ACCESS_DENIED 0x00000005	Access is denied. The client's fax user account does not have the FAX_CONFIG_QUERY access rights.
ERROR_NOT_ENOUGH_MEMORY 0x00000008	The fax server cannot allocate sufficient memory to hold the array of FAX_LOG_CATEGORY structures to be returned to the client.
ERROR_INVALID_PARAMETER 0x00000057	The parameter is incorrect. This error is returned if one of more of the following parameters are set to NULL pointer values: Buffer, BufferSize, NumberCategories. <210>

Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying RPC protocol, [MS-RPCE].