Share via


FaxIncomingJob object

The FaxIncomingJob object is used by a fax client application to retrieve information about an incoming fax job in a fax server's queue. The object also includes methods to cancel an incoming fax job and to copy the Tagged Image File Format Class F (TIFF Class F) file associated with an inbound fax job, to a file on the local computer.

A FaxIncomingJob object is accessed through a FaxIncomingJobs object.

faxincomingqueue, faxincomingjobs, and faxincomingjob objects

Members

The FaxIncomingJob object has these types of members:

Methods

The FaxIncomingJob object has these methods.

Method Description
Cancel The Cancel method cancels the incoming fax job.
CopyTiff The CopyTiff method copies the TIFF Class F file associated with the inbound fax job to a file on the local computer.
Refresh The Refresh method refreshes FaxIncomingJob object information from the fax server.

 

Properties

The FaxIncomingJob 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 string that identifies the calling device that sent the inbound 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 receiving on an inbound fax job.
DeviceId
Read-only
The DeviceId property indicates the device ID of the device receiving the inbound 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.
Id
Read-only
The Id property is a null-terminated string that contains a unique ID for the inbound fax job.
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.
Retries
Read-only
The Retries property is a value that indicates the number of times the fax service attempted to route an incoming fax when the initial routing attempt failed.
RoutingInformation
Read-only
The RoutingInformation property is a null-terminated string that specifies routing information for the inbound fax job.
Size
Read-only
The Size property is a value that indicates the size of the TIFF Class F file associated with the inbound fax job.
Status
Read-only
The Status property is a number that indicates the current status of an inbound fax job in the job queue.
TransmissionEnd
Read-only
The TransmissionEnd property indicates the time at which the inbound fax job completed transmission.
TransmissionStart
Read-only
The TransmissionStart property indicates the time that the fax inbound job began transmitting.
TSID
Read-only
The TSID property is a null-terminated string that contains the TSID associated with the fax inbound job.

 

Remarks

To create a FaxIncomingJob object in Microsoft Visual Basic, call the Item property of the FaxIncomingJobs object.

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_FaxIncomingJob

See also

Fax Service object hierarchy

FaxIncomingJobs

IFaxIncomingJob