FAX_GLOBAL_ROUTING_INFO

The FAX_GLOBAL_ROUTING_INFO structure contains information about one fax routing method, as it pertains globally to the fax service. The structure includes data on the priority level of the fax routing method, and the name of the DLL that exports the routing method. It also includes the GUID and function name that identify the fax routing method, and the method's user-friendly name.

The Guid member is required to identify the fax routing method. Currently the Priority member is the only member that an application can modify.

typedef struct _FAX_GLOBAL_ROUTING_INFO {
  DWORD   SizeOfStruct;  // structure size, in bytes
  DWORD   Priority;      // priority of this method
  LPCTSTR Guid;          // GUID that uniquely identifies 
                         // the 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_GLOBAL_ROUTING_INFO, *PFAX_GLOBAL_ROUTING_INFO; 

Members

SizeOfStruct

Specifies the size, in bytes, of the FAX_GLOBAL_ROUTING_INFO structure. The calling application must set this member to sizeof(FAX_GLOBAL_ROUTING_INFO) before it calls the FaxSetGlobalRoutingInfo function.

Priority

Specifies a DWORD variable that indicates the priority of the fax routing method. The priority determines the relative order in which the fax service calls the fax routing methods when the service receives a fax document. Valid values for this member are 1 through n, where 1 is the highest priority.

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 method. 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 that implements the fax routing method.

Remarks

A fax client application can call the FaxEnumGlobalRoutingInfo function to retrieve fax routing method information that applies globally to the fax service. The function returns information about each fax routing method in an individual FAX_GLOBAL_ROUTING_INFO structure.

Call the FaxSetGlobalRoutingInfo function to modify fax routing method data that applies globally to the fax server, such as routing priority.

For more information, see Managing Global Fax Routing Data.

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, FaxEnumGlobalRoutingInfo, FaxSetGlobalRoutingInfo, FaxEnumRoutingMethods, FaxEnableRoutingMethod, FaxRouteMethod