IFaxStatus

The FaxStatus dual interface is used by a fax client application to retrieve status information for a specific port on a connected fax server. The IFaxStatus interface includes the following interface methods:

• A method to update status information for a fax port.
• Property methods to retrieve attributes of a FaxStatus object, such as whether the parent FaxPort is currently sending or receiving a fax transmission. Attributes also include document and transmission data, sender and recipient names, and routing information.

The FaxStatus object should only be created by a FaxPort object.

You can use the FaxStatus object to provide real-time status information about a parent FaxPort object. Some data is available at all times for an active fax port; other data is relative to sending or receiving a fax and is only available at those times.

When to Implement

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

When to Use

Use the IFaxStatus interface to update the status information for a specific fax port, and to retrieve the properties of a FaxStatus object.

A client application should not call the CoCreateInstance function to retrieve an IFaxStatus interface pointer. Instead, the application must perform the following steps to create an instance of a FaxStatus 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::GetPorts method to create and initialize a FaxPorts object for the connected fax server.
4. Call the IFaxPorts::get_Count method and then the IFaxPorts::get_Item method to retrieve IDispatch interface pointers for each child FaxPort object. (You can also call the IUnknown::QueryInterface method to retrieve an IFaxPort interface pointer.)
5. Use the IDispatch interface pointer to call the IFaxPort::GetStatus interface method, to retrieve an IDispatch interface pointer to a FaxStatus object.
6. Use the IDispatch interface pointer to call IFaxStatus interface methods.
7. Call the IFaxServer::Disconnect method to disconnect from the fax server.
8. Call the IUnknown::Release method for each FaxStatus object to allow the object to deallocate itself. Also call IUnknown::Release once for each FaxPort object, and again to destroy both the IFaxPorts and the parent IFaxServer interface pointers.

The property methods of the IFaxStatus interface retrieve the properties described following. For each property that supports read access, the IFaxStatus interface includes a get_PropertyName method.

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

Methods in Vtable Order

IUnknown Methods

IDispatch Methods

IFaxStatus Methods

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