3.1.4.1.61 FAX_GetServerActivity (Opnum 76)

The fax client application calls the FAX_GetServerActivity (Opnum 76) method to retrieve the status of the fax queue activity and event log reports.

The client MUST allocate memory for the pServerActivity argument. It MUST also set the dwSizeOfStruct field to the correct size, in bytes, of the FAX_SERVER_ACTIVITY structure as described in section 2.2.19.

In response, the server MUST validate that the client's fax user account has access to the server logs. On success, the server MUST return information about its activity and event logs.

 error_status_t FAX_GetServerActivity(
   [in] handle_t hFaxHandle,
   [in, out, ref] PFAX_SERVER_ACTIVITY pServerActivity
 );

hFaxHandle: The RPC binding handle for this call. The client SHOULD reuse the RPC binding handle used as an input hBinding argument for the FAX_ConnectFaxServer (section 3.1.4.1.10) or FAX_ConnectionRefCount (section 3.1.4.1.11) method call used to connect to the fax server.

pServerActivity: A pointer to a FAX_SERVER_ACTIVITY object.

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_ACCESS_QUERY_CONFIG access rights required for this operation.

ERROR_INVALID_PARAMETER

0x00000057

The parameter is incorrect. The dwSizeOfStruct member of the FAX_SERVER_ACTIVITY specified by the pServerActivity parameter on input is set by the client to an incorrect value. For more details about the correct size to be filled in this member, see the FAX_SERVER_ACTIVITY.

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