Platform SDK: Fax Services |
The FaxRoutingMethod object permits a fax client 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:
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.
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
Following is a list of the Visual Basic properties of FaxRoutingMethod objects.
Property | Visual Basic Example |
---|---|
DeviceId LONG Read-only |
|
Permanent line identifier of the fax port associated with the specified fax routing method. |
Dim lDeviceId As Long lDeviceId = objFaxRoutingMethod.DeviceId |
DeviceName STRING Read-only |
|
User-friendly display name of the fax port associated with the specified fax routing method. |
Dim strDeviceName As String strDeviceName = objFaxRoutingMethod.DeviceName |
Enable LONG Read/Write |
|
Value that indicates whether the fax routing method is enabled for the specified fax port. If this property is a nonzero value, the routing method is enabled for the port. |
' Retrieve Dim lEnable As LONG lEnable = objFaxRoutingMethod.Enable ' Assign objFaxRoutingMethod.Enable = – 1 |
ExtensionName STRING Read-only |
|
User-friendly display name for the fax routing extension DLL that implements the specified fax routing method. |
Dim strExtName As String strExtName = objFaxRoutingMethod.ExtensionName |
FriendlyName STRING Read-only |
|
User-friendly display name for the specified routing method. |
Dim strFrName As String strFrName = objFaxRoutingMethod.FriendlyName |
FunctionName STRING Read-only |
|
Name of the routing extension-defined function that executes a specific fax routing method. |
Dim strFuncName As String strFuncName = objFaxRoutingMethod.FunctionName |
Guid STRING Read-only |
|
GUID that uniquely identifies the specified routing method. |
Dim strGuid As String strGuid = objFaxRoutingMethod.Guid |
ImageName STRING Read-only |
|
Executable image name of the fax routing extension DLL that implements the fax routing method. |
Dim strImageName As String strImageName = objFaxRoutingMethod.ImageName |
RoutingData STRING Read-only |
|
Persistent routing data for a fax routing method. |
Dim strRData As String strRData = objFaxRoutingMethod.RoutingData |