3.1.4.1.90 FAX_SetQueue (Opnum 33)

The fax client application calls the FAX_SetQueue (Opnum 33) method to change the state of the server queue. In response, the server MUST validate whether the client's fax user account has authorization to set the Queue State of the server. On success, the server MUST set its Queue State as specified by the client.

 error_status_t FAX_SetQueue(
   [in] handle_t hFaxHandle,
   [in] const DWORD dwQueueStates
 );

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.

dwQueueStates: A pointer to a DWORD ([MS-DTYP] section 2.2.9) value that contains 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
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 the required FAX_ACCESS_MANAGE_CONFIG authorization for this operation.
ERROR_OUTOFMEMORY 0x0000000E	The fax server cannot allocate sufficient memory for a FAX_EVENT_EX_1 (section 2.2.68) structure that describes a FAX_EVENT_QUEUE_TYPE_QUEUE_STATE event to be signaled to the client. For more details, see FAX_ClientEventQueueEx (section 3.2.4.3).
ERROR_INVALID_PARAMETER 0x00000057	The parameter is incorrect. The dwQueueStates parameter is set to a combination of values that does not contain any of the supported values: FAX_INCOMING_BLOCKED, FAX_OUTBOX_BLOCKED, or FAX_OUTBOX_PAUSED.
ERROR_REGISTRY_CORRUPT 0x000003F7	The registry is corrupted. The structure of one of the files containing registry data is corrupted, or the system's memory image of the file is corrupted, or the file could not be recovered because the alternate copy or log was absent or corrupted.
RPC_E_SYS_CALL_FAILED 0x80010100	dwQueueStates includes the FAX_OUTBOX_PAUSED value and the fax server cannot pause the server queue, or dwQueueStates does not include the FAX_OUTBOX_PAUSED value and the fax server cannot resume the server queue.

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