Platform SDK: Fax Services

IFaxJobs

The IFaxJobs dual interface is used by a fax client application to access the FaxJob objects derived from a FaxServer object. The interface enumerates the fax jobs associated with a connected fax server.

A FaxJobs object is a collection of FaxJob objects.

The IFaxJobs interface includes methods that allow a fax client application to perform the following tasks:

When to Implement

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

When to Use

Use the IFaxJobs interface to create and retrieve IFaxJob interface pointers to FaxJob objects. There is one FaxJob object for each queued job associated with the connected fax server.

To create an instance of a FaxJob object, perform the following steps. Note that a fax client application should not call the CoCreateInstance function to retrieve an IFaxJob interface pointer.

  1. Call the CoCreateInstance function to retrieve a pointer to an IFaxServer interface.
  2. Call the IFaxServer::Connect method to connect to a fax server.
  3. Call the IFaxServer::GetJobs method to create and initialize a FaxJobs object for the 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.
  5. Use the IDispatch interface pointer to call IFaxJob interface methods. (You can also call the IUnknown::QueryInterface method to retrieve an IFaxJob interface pointer.)
  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 IFaxJobs interface retrieve the properties described following. Because these properties support read access, the IFaxJobs interface includes a get_PropertyName method for each property.

Property Type Access Description
Count LONG R Number of fax jobs associated with the connected fax server.
Item VARIANT R IDispatch interface pointer to a FaxJob object.

Methods in Vtable Order

IUnknown Methods

IDispatch Methods

IFaxJobs Methods

Method Description
get_Count Retrieves the number of FaxJob objects associated with the connected fax server.
get_Item Creates a FaxJob object for a specified 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