IFaxServer::get_PauseServerQueue

The IFaxServer::get_PauseServerQueue method retrieves the PauseServerQueue property for a FaxServer object. The PauseServerQueue property is a Boolean value that indicates whether the fax server has paused the fax job queue.

Visual Basic Reference

HRESULT get_PauseServerQueue(
  BOOL *pVal  // receives pause queue flag
);

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether the fax server has paused the outbound fax job queue. If this value is TRUE, the queue has been paused. If this value is FALSE, the queue is active.

Return Values

Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.

You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.

Remarks

An administrator might pause the fax job queue for various reasons. For example, the administrator may need to perform queue management, or free a fax device for an inbound reception or for another application's use.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxServer, IFaxServer::put_PauseServerQueue