IFaxOutboundRoutingGroups::Remove method (faxcomex.h)

Article
02/22/2024

The Remove method removes an item from the FaxOutboundRoutingGroups collection.

Note You cannot remove the special All Devices routing group.

Syntax

HRESULT Remove(
  VARIANT vIndex
);

Parameters

vIndex

Type: VARIANT

Variant that specifies the item to remove from the collection.

If this parameter is type VT_I2 or VT_I4, it 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 objects returned by a call to the IFaxOutboundRoutingGroups::get_Count method. The index is 1-based. If this parameter is type VT_BSTR, the parameter is a unique name that identifies the outbound routing group to remove. Other types are not supported.

Return value

Type: HRESULT

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

Remarks

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

Share via