Platform SDK: Fax Services

FaxRouteSetRoutingInfo

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

BOOL WINAPI FaxRouteSetRoutingInfo(
  LPCWSTR RoutingGuid,      // pointer to the GUID for the
                            //   routing method 
  DWORD DeviceId,           // identifier of the fax device
                            //   to modify 
  CONST BYTE *RoutingInfo,  // pointer to the buffer that
                            //   provides configuration data 
  DWORD RoutingInfoSize     // size, in bytes, of the buffer
);

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 device identifier of the fax device that will have its routing configuration data modified.
RoutingInfo
[in] Pointer to a buffer that provides the fax routing configuration data.
RoutingInfoSize
[in] Specifies the size, in bytes, of the buffer pointed to by the RoutingInfo parameter.

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 FaxRouteSetRoutingInfo function to modify routing configuration data for a specific fax device.

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, FaxRouteGetRoutingInfo