FaxRouteDeviceEnable function (faxroute.h)

Article
02/22/2024

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.

Syntax

BOOL FaxRouteDeviceEnable(
  [in] LPCWSTR RoutingGuid,
  [in] DWORD   DeviceId,
  [in] LONG    Enabled
);

Parameters

[in] RoutingGuid

Type: LPCWSTR

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

[in] DeviceId

Type: DWORD

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

[in] Enabled

Type: LONG

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 one of the following values.

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 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.

This function will return ERROR_BAD_CONFIGURATION if you attempt to refer to a device that is not configured, such as a folder that has not been specified, or a printer that does not exist on your network.

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