FaxRouteDeviceChangeNotification

The fax service calls the FaxRouteDeviceChangeNotification function to inform a fax routing extension DLL that a fax device has been removed from the fax server, or that a new fax device has been installed. Each fax routing extension must export the FaxRouteDeviceChangeNotification function.

BOOL WINAPI FaxRouteDeviceChangeNotification(
  DWORD DeviceId,  // fax device identifier
  BOOL NewDevice   // new fax device flag
);

Parameters

DeviceId

[in] Specifies a DWORD variable that is the device identifier of the fax device that has been removed or installed.

NewDevice

[in] Specifies a Boolean variable that indicates whether the DeviceId parameter identifies a new device. If this parameter is equal to TRUE, the device is a new device. 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, call GetLastError.

Remarks

If the NewDevice parameter is equal to TRUE, it indicates that the fax service detects the installation of a new fax device. The fax routing extension must perform any initialization procedures necessary to enable the extension to route inbound fax transmissions using the new device.

If the NewDevice parameter is equal to FALSE, it indicates that the fax service detects the removal of the fax device identified by the DeviceId parameter. The fax routing extension should perform required cleanup routines at this time.

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