IFaxDeviceIds::Remove method (faxcomex.h)

Article
02/22/2024

The IFaxDeviceIds::Remove method removes an item from the FaxDeviceIds collection.

Syntax

HRESULT Remove(
  [in] long lIndex
);

Parameters

[in] lIndex

Type: long

A long value that specifies the index of the item to remove from the collection. Valid values for this parameter are in the range from 1 to n, where n is the number of devices returned by a call to the IFaxDeviceIds::get_Count property.

Return value

Type: HRESULT

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

Remarks

Note You cannot remove devices from the special All Devices routing group.

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