FaxRouteSetRoutingInfo function (faxroute.h)

Article
02/22/2024

The FaxRouteSetRoutingInfo function modifies routing configuration data for a specific fax device. Each fax routing extension DLL must export the FaxRouteSetRoutingInfo function.

Syntax

BOOL FaxRouteSetRoutingInfo(
  [in] LPCWSTR    RoutingGuid,
  [in] DWORD      DeviceId,
  [in] const BYTE *RoutingInfo,
  [in] DWORD      RoutingInfoSize
);

Parameters

[in] RoutingGuid

Type: LPCWSTR

Pointer to a constant null-terminated Unicode character string that contains the GUID for the fax routing method.

[in] DeviceId

Type: DWORD

Specifies the device identifier of the fax device that will have its routing configuration data modified.

[in] RoutingInfo

Type: const BYTE*

Pointer to a buffer that provides the fax routing configuration data.

[in] RoutingInfoSize

Type: DWORD

Specifies the size, in bytes, of the buffer pointed to by the RoutingInfo parameter.

Return value

Type: BOOL

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, the fax service calls GetLastError, described in MSDN.

Remarks

The fax service calls the FaxRouteSetRoutingInfo function to modify routing configuration data for a specific fax device.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	faxroute.h