IFaxJob::get_QueueStatus

The IFaxJob::get_QueueStatus method retrieves the QueueStatus property for a FaxJob object. The QueueStatus property is a null-terminated string that describes the job queue status of the fax job.

Visual Basic Reference

HRESULT get_QueueStatus(
  BSTR *pVal  // receives queue status
);

Parameters

pVal

[out] Pointer to a localized null-terminated string that contains the queue status of the specified fax job. Following are the English string equivalents.

Value	Meaning
"Pending"	The fax job is in the queue and pending service.
"In Progress"	The fax job is in progress.
"Deleting"	The fax server is deleting the fax job.
"Failed"	The fax job failed.
"Paused"	The fax server paused the fax job.
"No Line"	There is no line available to send the fax. The fax server will send the transmission when a line is available.
"Retrying"	The fax job failed. The fax server will attempt to retransmit the fax after a specified interval.
"Retries Exceeded"	The fax server exceeded the maximum number of retransmission attempts allowed. The fax will not be sent.

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

The IFaxJob::get_QueueStatus method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.

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, IFaxJob, IFaxJobs, SysFreeString