FaxRouteDeviceEnable

The FaxRouteDeviceEnable function allows a fax routing extension DLL to query, enable, or disable a fax routing method for a specific fax device. Each fax routing extension must export the FaxRouteDeviceEnable function.

BOOL WINAPI FaxRouteDeviceEnable(
  LPCWSTR RoutingGuid,  //pointer to the GUID for the routing method
  DWORD DeviceId,       //fax device identifier
  LONG Enabled          //enabled status for the device and method
);

Parameters

RoutingGuid

[in] Pointer to a constant null-terminated Unicode character string that contains the GUID for the fax routing method of interest.

DeviceId

[in] Specifies a DWORD variable that is the device identifier for the fax device of interest.

Enabled

[in] Specifies an enabled status for the fax routing method and fax device combination specified by the RoutingGuid and DeviceId parameters.

The Enabled parameter can have the following values.

typedef enum  FAXROUTE_ENABLE {
    QUERY_STATUS = -1,
    STATUS_DISABLE = 0,
    STATUS_ENABLE = 1
};

These values have the following meanings.

Value	Meaning
QUERY_STATUS	Return the current status of the specified routing method on the specified fax device. A value of TRUE indicates the routing method is enabled on the device; a value of FALSE indicates the routing method is disabled on the device.
STATUS_DISABLE	Disable the specified fax routing method on the specified fax device.
STATUS_ENABLE	Enable the specified fax routing method on the specified fax device.

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.

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