3.1.4.2.27 FaxObs_SetLoggingCategories (Opnum 25)

The FaxObs_SetLoggingCategories (Opnum 25) method is called by the client to set the current logging categories on the server. A logging category determines the errors or other events that the fax server records in the application event log.

On success, the server MUST modify its current logging categories.

 error_status_t FaxObs_SetLoggingCategories(
   [in] handle_t hBinding,
   [in, unique, size_is(BufferSize)] 
     const LPBYTE Buffer,
   [in] DWORD BufferSize,
   [in] DWORD NumberCategories
 );

hBinding: A handle that is provided by the client RPC layer when the RPC call is made.

Buffer: A pointer to an array of FAX_LOG_CATEGORY (section 2.2.11) structures. Each structure contains the data to modify one logging category. The data includes a friendly name of the logging category, a numeric identifier for the category, and the current severity-level threshold for the category. For more information, see [MSDN-FSCAR].

BufferSize: A DWORD ([MS-DTYP] section 2.2.9) variable that contains the size, in bytes, of the data buffer.

NumberCategories: A DWORD variable that contains the number of FAX_LOG_CATEGORY structures that the method passes 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_SET access rights.

ERROR_INVALID_PARAMETER

0x00000057

The parameter is incorrect. This error code is returned under any of the following conditions:

§ The value specified for the Buffer parameter is NULL.

§ The value specified for the BufferSize parameter is 0.

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