IFaxOutgoingJob interface (faxcomex.h)

The IFaxOutgoingJob interface describes an object that is used by a fax client application to retrieve information about an outgoing fax job in a fax server's queue. The object also includes methods to cancel, pause, resume, or restart an outgoing fax job, and to copy the Tagged Image File Format Class F (TIFF Class F) file associated with an outbound fax job, to a file on the local computer.

Inheritance

The IFaxOutgoingJob interface inherits from the IDispatch interface. IFaxOutgoingJob also has these types of members:

Methods

The IFaxOutgoingJob interface has these methods.

IFaxOutgoingJob::Cancel The IFaxOutgoingJob::Cancel method cancels the outbound fax job.
IFaxOutgoingJob::CopyTiff The IFaxOutgoingJob::CopyTiff method copies the Tagged Image File Format Class F (TIFF Class F) file associated with the outbound fax job, to a file on the local computer.
IFaxOutgoingJob::get_AvailableOperations The IFaxOutgoingJob::get_AvailableOperations property indicates the combination of valid operations that you can perform on the fax job, given its current status.
IFaxOutgoingJob::get_CSID The IFaxOutgoingJob::get_CSID property is a null-terminated string that contains the called station identifier (CSID) associated with the fax outbound job.
IFaxOutgoingJob::get_CurrentPage The IFaxOutgoingJob::get_CurrentPage property is a number that identifies the page that the fax service is actively transmitting on an outbound fax job.
IFaxOutgoingJob::get_DeviceId The IFaxOutgoingJob::get_DeviceId property indicates the device ID of the device transmitting the outbound fax job.
IFaxOutgoingJob::get_DocumentName The IFaxOutgoingJob::get_DocumentName property is a null-terminated string that contains the user-friendly name to display for the fax document.
IFaxOutgoingJob::get_ExtendedStatus The IFaxOutgoingJob::get_ExtendedStatus property is a null-terminated string that describes the job's extended status.
IFaxOutgoingJob::get_ExtendedStatusCode The IFaxOutgoingJob::get_ExtendedStatusCode property specifies a code describing the job's extended status.
IFaxOutgoingJob::get_GroupBroadcastReceipts The IFaxOutgoingJob::get_GroupBroadcastReceipts property is a Boolean value that indicates whether to send an individual delivery receipt for each recipient of the broadcast or to send a summary receipt for all recipients.
IFaxOutgoingJob::get_Id The IFaxOutgoingJob::get_Id property is a null-terminated string that contains a unique identifier for the outbound fax job. You can use the identifier to retrieve the archived fax message after the job completes successfully.
IFaxOutgoingJob::get_OriginalScheduledTime The IFaxOutgoingJob::get_OriginalScheduledTime property specifies the time that the fax job was originally scheduled for transmission.
IFaxOutgoingJob::get_Pages The IFaxOutgoingJob::get_Pages property is a number that indicates the total number of pages in the outbound fax job.
IFaxOutgoingJob::get_Priority The IFaxOutgoingJob::get_Priority property specifies the priority to use when sending the fax; for example, normal, low, or high priority.
IFaxOutgoingJob::get_ReceiptType The IFaxOutgoingJob::get_ReceiptType property is a value that specifies the type of delivery receipt to deliver when the fax message reaches a final state. The receipt type can be Simple Mail Transport Protocol (SMTP) mail, a message box, or no receipt.
IFaxOutgoingJob::get_Recipient The IFaxOutgoingJob::get_Recipient property retrieves an interface to an object containing information about the recipient of the fax job.
IFaxOutgoingJob::get_Retries The IFaxOutgoingJob::get_Retries property is a value that indicates the number of times that the fax service attempted to transmit an outgoing fax after the initial transmission attempt failed.
IFaxOutgoingJob::get_ScheduledTime The IFaxOutgoingJob::get_ScheduledTime property indicates the time to submit the fax for processing to the fax service.
IFaxOutgoingJob::get_Sender The IFaxOutgoingJob::get_Sender property retrieves an object containing information about the sender of the fax.
IFaxOutgoingJob::get_Size The IFaxOutgoingJob::get_Size property is a value that indicates the size of the Tagged Image File Format Class F (TIFF Class F) file associated with the outbound fax job.
IFaxOutgoingJob::get_Status The IFaxOutgoingJob::get_Status property is a number that indicates the current status of an outbound fax job in the job queue.
IFaxOutgoingJob::get_Subject The IFaxOutgoingJob::get_Subject property is a null-terminated string that contains the contents of the subject field on the cover page of the fax.
IFaxOutgoingJob::get_SubmissionId The IFaxOutgoingJob::get_SubmissionId property is a null-terminated string that contains the unique identifier assigned to the fax job during the submission process.
IFaxOutgoingJob::get_SubmissionTime The IFaxOutgoingJob::get_SubmissionTime property indicates the time that the outbound fax job was submitted for processing.
IFaxOutgoingJob::get_TransmissionEnd The IFaxOutgoingJob::get_TransmissionEnd property indicates the time that the outbound fax job completed transmission.
IFaxOutgoingJob::get_TransmissionStart The IFaxOutgoingJob::get_TransmissionStart property indicates the time that the fax outbound job began transmitting. This property will have a value only after the transmission has started.
IFaxOutgoingJob::get_TSID The IFaxOutgoingJob::get_TSID property is a null-terminated string that contains the transmitting station identifier (TSID) associated with the fax outbound job.
IFaxOutgoingJob::Pause The IFaxOutgoingJob::Pause method pauses the outbound fax job.
IFaxOutgoingJob::Refresh The Refresh method refreshes FaxOutgoingJob object information from the fax server.
IFaxOutgoingJob::Restart The IFaxOutgoingJob::Restart method restarts the failed outbound fax job. For example, if the fax job has exceeded the number of retries, IFaxOutgoingJob::Restart will restart the fax job.
IFaxOutgoingJob::Resume The IFaxOutgoingJob::Resume method resumes the paused outbound fax job.

Remarks

A default implementation of IFaxOutgoingJob is provided as the FaxOutgoingJob object.

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