IFaxJobStatus interface (faxcomex.h)
The IFaxJobStatus interface 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.
Inheritance
The IFaxJobStatus interface inherits from the IDispatch interface.
Methods
The IFaxJobStatus interface has these methods.
| IFaxJobStatus::get_AvailableOperations The AvailableOperations property indicates the combination of valid operations that you can perform on the fax job, given its current status. |
| IFaxJobStatus::get_CallerId The CallerId property is a null-terminated string that identifies the calling device associated with the fax job. |
| IFaxJobStatus::get_CSID The CSID property is a null-terminated string that contains the called station identifier (CSID) for the job. (IFaxJobStatus.get_CSID) |
| IFaxJobStatus::get_CurrentPage The CurrentPage property is a number that identifies the page that the fax service is actively processing. |
| IFaxJobStatus::get_DeviceId The DeviceId property indicates the device ID of the device associated with the fax job. |
| IFaxJobStatus::get_ExtendedStatus The ExtendedStatus property is a null-terminated string that describes the job's extended status. (IFaxJobStatus.get_ExtendedStatus) |
| IFaxJobStatus::get_ExtendedStatusCode The ExtendedStatusCode property specifies a code describing the job's extended status. |
| IFaxJobStatus::get_JobType 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. |
| IFaxJobStatus::get_Pages The Pages property is a number that indicates the total number of pages received so far in the fax transmission. |
| IFaxJobStatus::get_Retries 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. |
| IFaxJobStatus::get_RoutingInformation The RoutingInformation property is a null-terminated string that specifies the routing information for the fax job. |
| IFaxJobStatus::get_ScheduledTime The ScheduledTime property indicates the time that the fax job is scheduled for transmission. |
| IFaxJobStatus::get_Size The Size property is a value that indicates the number of bytes of the Tagged Image File Format Class F (TIFF Class F) file received so far for the fax job. |
| IFaxJobStatus::get_Status The Status property is a number that indicates the current status of fax job in the job queue. |
| IFaxJobStatus::get_TransmissionEnd The TransmissionEnd property indicates the time that the fax job completed transmission. |
| IFaxJobStatus::get_TransmissionStart The TransmissionStart property indicates the time that the fax job began transmitting. |
| IFaxJobStatus::get_TSID The TSID property is a null-terminated string that contains the transmitting station identifier (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 IFaxServerNotify::OnIncomingJobChanged or IFaxServerNotify::OnOutgoingJobChanged, which include a parameter of the type FaxJobStatus. When the event occurs and the implemented function is called, you receive this object containing the dynamic information.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | faxcomex.h |