FaxRouteGetRoutingInfo function (faxroute.h)

Article
10/13/2021

The FaxRouteGetRoutingInfo function queries the fax routing extension DLL to obtain routing configuration data for a specific fax device. Each fax routing extension DLL must export the FaxRouteGetRoutingInfo function.

Syntax

BOOL FaxRouteGetRoutingInfo(
  [in]  LPCWSTR RoutingGuid,
  [in]  DWORD   DeviceId,
  [in]  LPBYTE  RoutingInfo,
  [out] LPDWORD 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 identifier of the fax device to query.

[in] RoutingInfo

Type: LPBYTE

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

[out] RoutingInfoSize

Type: LPDWORD

Pointer to an unsigned DWORD variable that specifies the size, in bytes, of the buffer pointed to by the RoutingInfo parameter. For more information, see the following Remarks section.

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 FaxRouteGetRoutingInfo function twice. On the first call to the function the fax service passes a null pointer in the RoutingInfo parameter. The fax routing extension DLL must set the RoutingInfoSize parameter to the size required for the RoutingInfo buffer. The fax service calls FaxRouteGetRoutingInfo a second time with a valid pointer to the RoutingInfo buffer.

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

Share via