Edit

IFaxJobs interface (faxcom.h)

  • Article

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.

  • Retrieve the number of fax jobs associated with a connected fax server.
  • Create and retrieve IFaxJob interface pointers for FaxJob objects.

Inheritance

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

Methods

The IFaxJobs interface has these methods.

 
IFaxJobs::get_Count

The IFaxJobs::get_Count method returns the number of queued fax jobs associated with the connected fax server.
IFaxJobs::get_Item

The IFaxJobs::get_Item method returns a new FaxJob object for a specified fax job. The object allows enumeration of the fax jobs associated with a connected fax server.

Remarks

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.

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

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

IDispatch