FAX_GLOBAL_ROUTING_INFOA structure (winfax.h)

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.

Syntax

typedef struct _FAX_GLOBAL_ROUTING_INFOA {
  DWORD  SizeOfStruct;
  DWORD  Priority;
  LPCSTR Guid;
  LPCSTR FriendlyName;
  LPCSTR FunctionName;
  LPCSTR ExtensionImageName;
  LPCSTR ExtensionFriendlyName;
} FAX_GLOBAL_ROUTING_INFOA, *PFAX_GLOBAL_ROUTING_INFOA;

Members

SizeOfStruct

Type: DWORD

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

Type: DWORD

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

Type: LPCTSTR

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

Type: LPCTSTR

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

FunctionName

Type: LPCTSTR

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

Type: LPCTSTR

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

Type: LPCTSTR

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.

Note

The winfax.h header defines FAX_GLOBAL_ROUTING_INFO as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	winfax.h

See also

Fax Service Client API Structures

Fax Service Client API for Windows 2000

FaxEnableRoutingMethod

FaxEnumGlobalRoutingInfo

FaxEnumRoutingMethods

FaxRouteMethod

FaxSetGlobalRoutingInfo