IFaxDeviceIds::SetOrder method (faxcomex.h)

Article
02/22/2024

The IFaxDeviceIds::SetOrder method changes the order of a device in the ordered FaxDeviceIds collection.

Syntax

HRESULT SetOrder(
  [in] long lDeviceId,
  [in] long lNewOrder
);

Parameters

[in] lDeviceId

Type: long

Specifies the device ID of the device whose order you want to change.

[in] lNewOrder

Type: long

Specifies the new position of the device in the order.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

You identify the device with its device ID, and then choose a new place for it in the order. If you move the device closer to the top of the order, the devices below that position in the order will drop down to accommodate the change. If you move the device closer to the bottom of the order, the devices above that position in the order will move up to fill the gap caused by the change.

In a fax device group, the relative order of the devices within the group is significant. When the fax service initiates an outgoing job, it attempts to select the first fax device in the device group. If that device is not available, the service selects the next available device that follows in rank order, and so on. For more information, see Fax Device Groups.

To use this method, a user must have the farMANAGE_CONFIG access right.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	faxcomex.h
DLL	Fxscomex.dll