FaxJobStatus object

The FaxJobStatus object is used for notifications and to hold the dynamic information of the job. Dynamic information is data that changes as a job progresses. This may include the current job status, the page that is currently being transmitted, and the number of attempts the fax service has made to transmit the job (retries). The fax service uses this object to notify a fax client application of job updates. For more information, see Fax Job Status.

Members

The FaxJobStatus object has these types of members:

• Properties

Properties

The FaxJobStatus object has these properties.

Property	Access type	Description
AvailableOperations	Read-only	The AvailableOperations property indicates the combination of valid operations that you can perform on the fax job, given its current status.
CallerId	Read-only	The CallerId property is a null-terminated string that identifies the calling device associated with the fax job.
CSID	Read-only	The CSID property is a null-terminated string that contains the CSID for the job.
CurrentPage	Read-only	The CurrentPage property is a number that identifies the page that the fax service is actively processing.
DeviceId	Read-only	The DeviceId property indicates the device ID of the device associated with the fax job.
ExtendedStatus	Read-only	The ExtendedStatus property is a null-terminated string that describes the job's extended status.
ExtendedStatusCode	Read-only	The ExtendedStatusCode property specifies a code describing the job's extended status.
JobType	Read-only	The JobType property describes the type of fax job; for example, the job can be a receive job, a send job, or a routing job.
Pages	Read-only	The Pages property is a number that indicates the total number of pages received so far in the fax transmission.
Retries	Read-only	The Retries property is a value that indicates the number of times that the fax service attempted to transmit a fax job when the initial attempt failed.
RoutingInformation	Read-only	The RoutingInformation property is a null-terminated string that specifies the routing information for the fax job.
ScheduledTime	Read-only	The ScheduledTime property indicates the time that the fax job is scheduled for transmission.
Size	Read-only	The Size property is a value that indicates the number of bytes of the TIFF Class F file received so far for the fax job.
Status	Read-only	The Status property is a number that indicates the current status of fax job in the job queue.
TransmissionEnd	Read-only	The TransmissionEnd property indicates the time that the fax job completed transmission.
TransmissionStart	Read-only	The TransmissionStart property indicates the time that the fax job began transmitting.
TSID	Read-only	The TSID property is a null-terminated string that contains the TSID associated with the fax job.

 

Remarks

You do not create the FaxJobStatus object. It is received as part of a notification when you implement FaxServerNotify.OnIncomingJobChanged or FaxServerNotify.OnOutgoingJobChanged, which include a pointer to the FaxJobStatus object. When the event occurs and the implemented function is called, you receive this object containing the dynamic information.

Requirements

Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	Faxcomex.h
DLL	Fxscomex.dll
IID	CLSID_FaxJobStatus

See also

IFaxJobStatus