IFaxJob interface (faxcom.h)

Article
07/22/2021

The IFaxJob dual interface is used by a fax client application to access information for a fax job on a connected fax server. A FaxJobs object is a collection of FaxJob objects.

The IFaxJob interface includes the following methods.

A method to modify the job queue status of a fax job.
A method to refresh FaxJob object information.
Property methods to retrieve individual property values associated with a FaxJob object retrieved by the IFaxJobs interface.

Inheritance

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

Methods

The IFaxJob interface has these methods.


IFaxJob::get_BillingCode The IFaxJob::get_BillingCode property is a null-terminated string that contains an optional billing code that applies to the fax job.
IFaxJob::get_DeviceStatus The IFaxJob::get_DeviceStatus property is a null-terminated string that describes the status of the port associated with the fax job.
IFaxJob::get_DiscountSend The IFaxJob::get_DiscountSend property is a Boolean value that indicates whether the fax server will transmit the fax job during the discount rate period. The discount period applies only to outgoing fax transmissions.
IFaxJob::get_DisplayName The IFaxJob::get_DisplayName property is a null-terminated string that contains the user-friendly name to associate with the fax job.
IFaxJob::get_FaxNumber The IFaxJob::get_FaxNumber property is a null-terminated string that contains the fax number to which the fax server will transmit the fax job. The IFaxJob::get_FaxNumber property applies only to outgoing fax transmissions.
IFaxJob::get_JobId The IFaxJob::get_JobId property is a number that uniquely identifies the specified fax job.
IFaxJob::get_PageCount The IFaxJob::get_PageCount property is a number that represents the total number of pages in a fax transmission. The IFaxJob::get_PageCount property applies only to outgoing fax transmissions.
IFaxJob::get_QueueStatus The IFaxJob::get_QueueStatus property is a null-terminated string that describes the job queue status of the fax job.
IFaxJob::get_RecipientName The IFaxJob::get_RecipientName property is a null-terminated string that contains the name of the recipient of the fax job.
IFaxJob::get_SenderCompany The IFaxJob::get_SenderCompany property is a null-terminated string that contains the company name for the sender of the fax job. The IFaxJob::get_SenderCompany property applies only to outgoing fax transmissions.
IFaxJob::get_SenderDept The IFaxJob::get_SenderDept property is a null-terminated string that contains the department identifier for the sender of the fax job. The IFaxJob::get_SenderDept property applies only to outgoing fax transmissions.
IFaxJob::get_SenderName The IFaxJob::get_SenderName property is a null-terminated string that contains the name of the sender who initiated the fax job. The IFaxJob::get_SenderName property applies only to outgoing fax transmissions.
IFaxJob::get_Tsid The IFaxJob::get_Tsid property is a null-terminated string that contains the transmitting station identifier (TSID)) associated with the fax job.
IFaxJob::get_Type The IFaxJob::get_Type property is a number that describes the type of fax job represented by the object.
IFaxJob::get_UserName The IFaxJob::get_UserName property is a null-terminated string that contains the name of the user who submitted the fax job to the job queue. The IFaxJob::get_UserName property applies only to outgoing fax transmissions.
IFaxJob::Refresh The IFaxJob::Refresh method updates FaxJob object information for the associated fax job.
IFaxJob::SetStatus Call the IFaxJob::SetStatus method to pause, resume, cancel, or restart a specified fax job.

Remarks

When to Implement

You should not implement this interface. The Microsoft standard implementation provides complete functionality.

When to Use

Use the IFaxJob interface to access the job status for incoming and outgoing fax transmissions, and to pause, resume, cancel or restart a fax job. You can also use the interface to retrieve the properties of a FaxJob object.

A client application should not call the CoCreateInstance function to retrieve an IFaxJob interface pointer. Instead, the application must perform the following steps to create an instance of a FaxJob object.

Call the CoCreateInstance function to retrieve a pointer to an IFaxServer interface.
Call the IFaxServer::Connect method to connect to an active fax server.
Call the IFaxServer::GetJobs method to create and initialize a FaxJobs object for the connected fax server.
Call the IFaxJobs::get_Count method and then the IFaxJobs::get_Item method to retrieve IDispatch interface pointers for each child FaxJob object. (You can also call the IUnknown::QueryInterface method to retrieve an IFaxJob interface pointer.)
Use the IDispatch interface pointer to call IFaxJob interface methods.
Call the IFaxServer::Disconnect method to disconnect from the fax server.
Call the IUnknown::Release method for each FaxJob object to allow the object to deallocate itself, and again to destroy the IFaxJobs interface pointer.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	faxcom.h