FaxSetRoutingInfoA function (winfax.h)

Article
02/09/2023

A fax management application calls the FaxSetRoutingInfo function to modify the routing information for a fax routing method that is associated with a specific fax device.

Syntax

WINFAXAPI BOOL FaxSetRoutingInfoA(
  [in] HANDLE     FaxPortHandle,
  [in] LPCSTR     RoutingGuid,
  [in] const BYTE *RoutingInfoBuffer,
  [in] DWORD      RoutingInfoBufferSize
);

Parameters

[in] FaxPortHandle

Type: HANDLE

Specifies a fax port handle returned by a call to the FaxOpenPort function.

[in] RoutingGuid

Type: LPCTSTR

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

For information about fax routing methods, see About the Fax Routing Extension API. For information about the relationship between routing methods and GUIDs, see Fax Routing Methods.

[in] RoutingInfoBuffer

Type: const BYTE*

Pointer to a buffer that contains the fax routing information. The routing data is typically provided by the fax service administration application, a MMC snap-in component.

[in] RoutingInfoBufferSize

Type: DWORD

Pointer to a DWORD variable that contains the size of the buffer, in bytes, pointed to by the RoutingInfoBuffer parameter.

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_PORT_SET access is required.
ERROR_INVALID_PARAMETER	One or more of the parameters are NULL.
ERROR_INVALID_DATA	The RoutingGuid parameter is invalid.

Remarks

The fax service administration application, an MMC snap-in component that manages the specified fax routing method, typically calls the FaxSetRoutingInfo function. This is because the format of the routing data is unavailable to the fax client application. The routing data is relevant only to the exported fax routing method and the method's administration application.

To obtain a valid port handle to specify in the FaxPortHandle parameter of the FaxSetRoutingInfo function, call the FaxOpenPort function.

The FaxEnumGlobalRoutingInfo function retrieves routing information that applies globally to the fax server, such as routing priority. An application can modify global data with a call to the FaxSetGlobalRoutingInfo function.

For more information, see Managing Fax Routing Data.

Note

The winfax.h header defines FaxSetRoutingInfo 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