FaxRoutingMethod object

The FaxRoutingMethod object permits a fax client Microsoft Visual Basic application to access fax routing configuration information for a fax port on a connected fax server. Use this object to enable or disable a fax routing method on a specific fax port, and to retrieve and set the properties of FaxRoutingMethod objects. There is one FaxRoutingMethod object for each routing method associated with the port.

The FaxRoutingMethod object has the following properties:

• Properties to retrieve, enable, or disable a fax routing method for a specific FaxPort object. (Fax routing methods are defined by fax routing extension DLLs.)
• Properties 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. When the service receives a fax, it executes only those routing methods that have been enabled for a device.

Members

The FaxRoutingMethod object has these types of members:

• Properties

Properties

The FaxRoutingMethod object has these properties.

Property	Access type	Description
DeviceId	Read-only	The DeviceId property is a number representing the line identifier for the fax port.
DeviceName	Read-only	The DeviceName property is a null-terminated string that contains the user-friendly display name for a fax port.
Enable	Read/write	The Enable property is a Boolean value that indicates whether a fax routing method is enabled on a particular fax port.
ExtensionName	Read-only	The 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.
FriendlyName	Read-only	The FriendlyName property is a null-terminated string that contains the user-friendly name for a fax routing method.
FunctionName	Read-only	The FunctionName property is a null-terminated string that contains the name of the function that executes a specific fax routing procedure.
Guid	Read-only	The Guid property is a null-terminated string that contains the GUID that uniquely identifies the fax routing method.
ImageName	Read-only	The 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.
RoutingData	Read-only	The RoutingData property is a null-terminated string that contains the routing string for an incoming fax transmission.

 

Remarks

When to Implement

You should not implement this class. The Microsoft standard implementation provides complete functionality. You can use the Visual Basic Object Browser to view the FaxRoutingMethod object's type library information in Visual Basic syntax.

To create a FaxRoutingMethod object

1. Call the Visual Basic CreateObject function to create a FaxServer object.
2. Call the GetRoutingMethods method of the FaxServer object to create a FaxRoutingMethods object on the connected fax server.
3. Retrieve the Count property and then the Item property for the FaxRoutingMethods collection to create a FaxRoutingMethod object.

Requirements

Header	Faxcom.h