FaxRouteGetRoutingInfo

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.

BOOL WINAPI FaxRouteGetRoutingInfo(
  LPCWSTR RoutingGuid,     // pointer to the GUID for the
                           //   routing method 
  DWORD DeviceId,          // identifier of the fax device to query
  LPBYTE RoutingInfo,      // pointer to the buffer to
                           //   receive configuration data
  LPDWORD RoutingInfoSize  // pointer to the buffer size, in bytes
);

Parameters

RoutingGuid

[in] Pointer to a constant null-terminated Unicode character string that contains the GUID for the fax routing method. For more information, see Registering a Fax Routing Method.

DeviceId

[in] Specifies the identifier of the fax device to query.

RoutingInfo

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

RoutingInfoSize

[out] 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 Values

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.

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

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxroute.h.
  Import Library: User-defined.

See Also

Fax Routing Extension Application Programming Interface Overview, Fax Routing Extension Functions, FaxRouteSetRoutingInfo