FaxSetGlobalRoutingInfoW function (winfax.h)

Article
02/09/2023

A fax management application calls the FaxSetGlobalRoutingInfo function to modify fax routing method data, such as routing priority, that applies globally to the fax server.

Syntax

WINFAXAPI BOOL FaxSetGlobalRoutingInfoW(
  [in] HANDLE                         FaxHandle,
  [in] const FAX_GLOBAL_ROUTING_INFOW *RoutingInfo
);

Parameters

[in] FaxHandle

Type: HANDLE

Specifies a fax server handle returned by a call to the FaxConnectFaxServer function.

[in] RoutingInfo

Type: const FAX_GLOBAL_ROUTING_INFO*

Pointer to a buffer that contains a FAX_GLOBAL_ROUTING_INFO structure.

Return value

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can return one of the following errors.

Return code	Description
ERROR_ACCESS_DENIED	Access is denied. FAX_CONFIG_SET access is required.
ERROR_INVALID_DATA	The Guid member of the specified FAX_GLOBAL_ROUTING_INFO structure does not correspond to an installed fax routing method.
ERROR_INVALID_PARAMETER	One or both of the FaxHandle or RoutingInfo parameters are invalid.

Remarks

An application such as the fax service administration application, a Microsoft Management Console (MMC) snap-in component that manages the specified fax routing method, typically calls the FaxSetGlobalRoutingInfo function.

To retrieve the current global configuration, call the FaxEnumGlobalRoutingInfo function. Call the FaxEnumRoutingMethods function to enumerate the fax routing methods associated with a particular device. For more information, see Managing Fax Routing Data.

Note

The winfax.h header defines FaxSetGlobalRoutingInfo 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]
Target Platform	Windows
Header	winfax.h
Library	WinFax.lib