Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The FaxOutgoingJob object 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.
Members
The FaxOutgoingJob object has these types of members:
Methods
The FaxOutgoingJob object has these methods.
Method | Description |
---|---|
Cancel | The Cancel method cancels the outbound fax job. |
CopyTiff | The CopyTiff method copies the TIFF Class F file associated with the outbound fax job, to a file on the local computer. |
Pause | The Pause method pauses the outbound fax job. |
Refresh | The Refresh method refreshes FaxOutgoingJob object information from the fax server. |
Restart | The Restart method restarts the failed outbound fax job. For example, if the fax job has exceeded the number of retries, Restart will restart the fax job. |
Resume | The Resume method resumes the paused outbound fax job. |
Properties
The FaxOutgoingJob 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. |
CSID |
Read-only |
The CSID property is a null-terminated string that contains the CSID associated with the fax outbound job. |
CurrentPage |
Read-only |
The CurrentPage property is a number that identifies the page that the fax service is actively transmitting on an outbound fax job. |
DeviceId |
Read-only |
The DeviceId property indicates the device ID of the device transmitting the outbound fax job. |
DocumentName |
Read-only |
The DocumentName property is a null-terminated string that contains the user-friendly name to display for the fax document. |
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. |
GroupBroadcastReceipts |
Read-only |
The 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. |
HasCoverPage |
Read-only |
Specifies if the fax has a cover page. |
Id |
Read-only |
The 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. |
OriginalScheduledTime |
Read-only |
The OriginalScheduledTime property specifies the time that the fax job was originally scheduled for transmission. |
Pages |
Read-only |
The Pages property is a number that indicates the total number of pages in the outbound fax job. |
Priority |
Read-only |
The Priority property specifies the priority to use when sending the fax; for example, normal, low, or high priority. |
ReceiptAddress |
Read-only |
A null-terminated string containing the address to which a delivery report will be sent, indicating success or failure. |
ReceiptType |
Read-only |
The 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 SMTP mail, a message box, or no receipt. |
Recipient |
Read-only |
The Recipient property retrieves an object containing information about the recipient of the fax job. |
Retries |
Read-only |
The 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. |
ScheduledTime |
Read-only |
The ScheduledTime property indicates the time to submit the fax for processing to the fax service. |
ScheduleType |
Read-only |
Specifies the schedule type that was used for the transmission. |
Sender |
Read-only |
The Sender property retrieves an object that contains information about the sender of the fax. |
Size |
Read-only |
The Size property is a value that indicates the size of the TIFF Class F file associated with the outbound fax job. |
Status |
Read-only |
The Status property is a number that indicates the current status of an outbound fax job in the job queue. |
Subject |
Read-only |
The Subject property is a null-terminated string that contains the contents of the subject field on the cover page of the fax. |
SubmissionId |
Read-only |
The SubmissionId property is a null-terminated string that contains the unique identifier assigned to the fax job during the submission process. |
SubmissionTime |
Read-only |
The SubmissionTime property indicates the time that the outbound fax job was submitted for processing. |
TransmissionEnd |
Read-only |
The TransmissionEnd property indicates the time that the outbound fax job completed transmission. |
TransmissionStart |
Read-only |
The TransmissionStart property indicates the time that the fax outbound job began transmitting. This property will have a value only after the transmission has started. |
TSID |
Read-only |
The TSID property is a null-terminated string that contains the TSID associated with the fax outbound job. |
Remarks
A FaxOutgoingJob object is accessed through a FaxOutgoingJobs object.
To create a FaxOutgoingJob object in Microsoft Visual Basic, retrieve the Item property of the FaxOutgoingJob object.
To create a IFaxOutgoingJob object in C++, call the get_Item method.
Requirements
Minimum supported client |
Windows XP [desktop apps only] |
Minimum supported server |
Windows Server 2003 [desktop apps only] |
Header |
|
DLL |
|
IID |
CLSID_FaxOutgoingJob |