Edit

IFaxRoutingMethod interface (faxcom.h)

  • Article

The IFaxRoutingMethod dual interface is used by a fax client application to retrieve fax routing configuration information for a fax port on a connected fax server. A FaxRoutingMethods object is a collection of FaxRoutingMethod objects.

The IFaxRoutingMethod interface includes the following interface methods.

  • Property methods to retrieve, enable, or disable a fax routing method for a specific FaxPort object. (Fax routing methods are defined by fax routing extension DLLs.)
  • Property methods to retrieve attributes of a FaxRoutingMethod object, such as the name of the DLL that exports the routing method. Attributes also include the GUID and function name that uniquely identify the routing method, and the routing method's user-friendly name.

A routing method is an action that is performed each time a fax is received on a port. If fax reception is not enabled on a port, the fax service disregards the routing methods associated with the port. Only enabled routing methods are executed when a fax is received.

Inheritance

The IFaxRoutingMethod interface inherits from the IDispatch interface.

Methods

The IFaxRoutingMethod interface has these methods.

 
IFaxRoutingMethod::get_DeviceId

The IFaxRoutingMethod::get_DeviceId property is a number representing the line identifier for the fax port.
IFaxRoutingMethod::get_DeviceName

The IFaxRoutingMethod::get_DeviceName property is a null-terminated string that contains the user-friendly display name for a fax port.
IFaxRoutingMethod::get_Enable

The IFaxRoutingMethod::get_Enable property is a Boolean value that indicates whether a fax routing method is enabled on a particular fax port. (Get)
IFaxRoutingMethod::get_ExtensionName

The IFaxRoutingMethod::get_ExtensionName property is a null-terminated string that contains the user-friendly name for the fax routing extension DLL that implements the specified fax routing method.
IFaxRoutingMethod::get_FriendlyName

The IFaxRoutingMethod::get_FriendlyName property is a null-terminated string that contains the user-friendly name for a fax routing method.
IFaxRoutingMethod::get_FunctionName

The IFaxRoutingMethod::get_FunctionName property is a null-terminated string that contains the name of the function that executes a specific fax routing procedure.
IFaxRoutingMethod::get_Guid

The IFaxRoutingMethod::get_Guid property is a null-terminated string that contains the GUID that uniquely identifies the fax routing method.
IFaxRoutingMethod::get_ImageName

The IFaxRoutingMethod::get_ImageName property is a null-terminated string that contains the executable image name of the fax routing extension DLL that implements the fax routing method.
IFaxRoutingMethod::get_RoutingData

The IFaxRoutingMethod::get_RoutingData property is a null-terminated string that contains the routing string for an incoming fax transmission.
IFaxRoutingMethod::put_Enable

The IFaxRoutingMethod::get_Enable property is a Boolean value that indicates whether a fax routing method is enabled on a particular fax port. (Put)

Remarks

When to Implement

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

When to Use

Use the IFaxRoutingMethod interface to enable or disable a fax routing method on a specific fax port, and to retrieve and set the properties of a FaxRoutingMethod object. There is one FaxRoutingMethod object for each routing method associated with the specified fax port.

A client application should not call the CoCreateInstance function to retrieve an IFaxRoutingMethod interface pointer. Instead, the application must perform the following steps to create an instance of a FaxRoutingMethod 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::GetRoutingMethods interface method, to retrieve an IDispatch interface pointer to a FaxRoutingMethods object.
  6. Call the IFaxRoutingMethods::get_Count method and then the IFaxRoutingMethods::get_Item method to retrieve IDispatch interface pointers for each child FaxRoutingMethod object.
  7. Use the IDispatch interface pointer to call IFaxRoutingMethod interface methods.
  8. Call the IFaxServer::Disconnect method to disconnect from the fax server.
  9. Call the IUnknown::Release method for each FaxRoutingMethod object to allow the object to deallocate itself. Also call IUnknown::Release for each FaxPort object, and to destroy the IFaxPorts 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