Platform SDK: Fax Services

IFaxJob

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:

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:

  1. Call the CoCreateInstance function to retrieve a pointer to an IFaxServer interface.
  2. Call the IFaxServer::Connect method to connect to an active fax server.
  3. Call the IFaxServer::GetJobs method to create and initialize a FaxJobs object for the connected fax server.
  4. 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.)
  5. Use the IDispatch interface pointer to call IFaxJob interface methods.
  6. Call the IFaxServer::Disconnect method to disconnect from the fax server.
  7. Call the IUnknown::Release method for each FaxJob object to allow the object to deallocate itself, and again to destroy the IFaxJobs interface pointer.

The property methods of the IFaxJob interface retrieve the properties described following. Because these properties support read access, the IFaxJob interface includes a get_PropertyName method for each property.

Following are the properties associated with a FaxJob object. You can find a complete list of IFaxJob interface methods in Vtable order following the list of properties.

Property Type Access Description
BillingCode BSTR R Application- or server-specific billing code that applies to the fax job. Billing codes are optional.
DeviceStatus BSTR R String that describes the status of the port associated with the fax job.
DiscountSend BOOL R Value that indicates whether the fax server will transmit the fax job during the discount rate period.
DisplayName BSTR R User-friendly display name to associate with the fax job.
FaxNumber BSTR R Fax number to which the fax server will transmit the outbound fax job.
JobId LONG R Number that uniquely identifies the specified fax job.
PageCount LONG R Total number of pages associated with the outbound fax job.
QueueStatus BSTR R String that describes the queue status of the specified fax job.
RecipientName BSTR R Name of the recipient of the fax job.
SenderCompany BSTR R Company name of the sender associated with the outbound fax job.
SenderDept BSTR R Department identifier of the sender associated with the outbound fax job.
SenderName BSTR R Name of the sender associated with the outbound fax job.
Tsid BSTR R Transmitting station identifier (TSID) to associate with the fax job.
Type LONG R Type of fax job represented by the FaxJob object.
UserName BSTR R Name of the user who submitted the outbound fax job to the job queue.

Methods in Vtable Order

IUnknown Methods

IDispatch Methods

IFaxJob Methods

Method Description
get_JobId Retrieves the number that uniquely identifies the specified fax job.
get_Type Retrieves the type of fax job represented by the FaxJob object.
get_UserName Retrieves the name of the user who submitted the outbound fax job to the job queue.
get_QueueStatus Retrieves a string that describes the queue status associated with the specified fax job.
get_DeviceStatus Retrieves a string that describes the status of the port associated with the fax job.
get_PageCount Retrieves the total number of pages in an outbound fax transmission.
get_FaxNumber Retrieves the fax number to which the fax server will send the outbound fax job.
get_RecipientName Retrieves the name of the recipient of the fax job.
get_Tsid Retrieves the transmitting station identifier (TSID) associated with the fax job.
get_SenderName Retrieves the name of the person who initiated the outbound fax job.
get_SenderCompany Retrieves the company name of the sender of the outbound fax job.
get_SenderDept Retrieves the department identifier of the sender of the outbound fax job.
get_BillingCode Retrieves the optional billing code that applies to the fax job.
get_DisplayName Retrieves the user-friendly display name to associate with the fax job.
get_DiscountSend Retrieves a value that indicates whether the fax server will transmit the fax job during the discount rate period.
SetStatus Changes the job status of a specified FaxJob object. Call this method to pause, resume, cancel, or restart a fax job.
Refresh Updates FaxJob object information for the associated fax job.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces

Built on Wednesday, February 09, 2000