3.1.4.1.53 FAX_GetQueueStates (Opnum 32)
The FAX_GetQueueStates (Opnum 32) method is called by the client to retrieve the state of the fax queues at the server.
The pdwQueueStates parameter MUST NOT be NULL. On success, the server MUST return the state information about the fax service.
-
error_status_t FAX_GetQueueStates( [in] handle_t hFaxHandle, [out] LPDWORD pdwQueueStates );
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.
pdwQueueStates: A pointer to a DWORD ([MS-DTYP] section 2.2.9) value that receives state information about the fax queue. If this value is zero, both the incoming and outgoing queues are unblocked. Otherwise, this value is a combination of one or more of the following values.
-
Value/code
Meaning
0x00000000
Both the incoming and outgoing queues are unblocked.
FAX_INCOMING_BLOCKED
0x00000001
The fax service will not receive new incoming faxes.
FAX_OUTBOX_BLOCKED
0x00000002
The fax service will reject submissions of new outgoing faxes to its queue.
FAX_OUTBOX_PAUSED
0x00000004
The fax service will not dequeue and execute outgoing fax jobs from its queue.
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 any of the permissions covered by ALL_FAX_USER_ACCESS_RIGHTS (section 2.2.83).
ERROR_INVALID_PARAMETER
0x00000057
The parameter is incorrect. The pdwQueueStates parameter is set to a NULL pointer value. <128>
Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying RPC protocol, [MS-RPCE].