FAX_ROUTING_METHOD

The FAX_ROUTING_METHOD structure contains information about one fax routing method, as it pertains to one fax device. The data includes, among other items, whether the fax routing method is enabled for the device, and the name of the DLL that exports the routing method. It also includes the GUID and function name that uniquely identify the routing method, and the method's user-friendly name.

typedef struct _FAX_ROUTING_METHOD {
  DWORD    SizeOfStruct;  //structure size, in bytes
  DWORD    DeviceId;      //line identifier of the device
  BOOL     Enabled;       //fax routing method enable/disable flag
  LPCTSTR  DeviceName;    //pointer to device name
  LPCTSTR  Guid;          //GUID that uniquely identifies 
                          //  the fax routing method
  LPCTSTR  FriendlyName;  //pointer to method's user-friendly name
  LPCTSTR  FunctionName;  //pointer to method's function name
  LPCTSTR  ExtensionImageName; 
                          //pointer to DLL that implements method
  LPCTSTR  ExtensionFriendlyName; 
                          //pointer to DLL's user-friendly name
} FAX_ROUTING_METHOD, *PFAX_ROUTING_METHOD; 

Members

SizeOfStruct

Specifies the size, in bytes, of the FAX_ROUTING_METHOD structure. The fax service sets this member to sizeof(FAX_ROUTING_METHOD).

DeviceId

Specifies a DWORD variable that indicates the permanent line identifier for the fax device of interest.

Enabled

Specifies a Boolean variable that indicates whether the fax routing method is enabled or disabled for the fax device of interest. If this parameter is equal to TRUE, the fax routing method is enabled for the device.

DeviceName

Pointer to a constant null-terminated character string that specifies the name of the fax device of interest.

Guid

Pointer to a constant null-terminated character string that specifies the GUID that uniquely identifies the fax routing method of interest.

For more information about fax routing methods, see About the Fax Routing Extension API.

FriendlyName

Pointer to a constant null-terminated character string that specifies the user-friendly name to display for the fax routing method.

FunctionName

Pointer to a constant null-terminated character string that is the name of the function that executes the specified fax routing procedure. The fax routing extension DLL identified by the ExtensionImageName member exports the function.

ExtensionImageName

Pointer to a constant null-terminated character string that specifies the name of the fax routing extension DLL that implements the fax routing method.

ExtensionFriendlyName

Pointer to a constant null-terminated character string that specifies the user-friendly name to display for the fax routing extension DLL.

Remarks

A fax client application can call the FaxEnumRoutingMethods function to enumerate all the fax routing methods associated with a specific fax device. The function returns an array of FAX_ROUTING_METHOD structures. Each structure describes one fax routing method in detail.

Call the FaxEnableRoutingMethod function to enable or disable a fax routing method for a specific fax device.

For more information, see Managing Fax Routing Data. For more information about GUIDs, see Registering a Fax Routing Method.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable with BackOffice Small Business Server.
  Header: Declared in Winfax.h.
  Unicode: Declared as Unicode and ANSI structures.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Structures, FaxEnumRoutingMethods, FaxRouteMethod, FaxEnableRoutingMethod