IFaxOutboundRoutingRules::Remove method (faxcomex.h)
The IFaxOutboundRoutingRules::Remove method removes an outbound routing rule (FaxOutboundRoutingRule object) from the FaxOutboundRoutingRules collection using the routing rule's index.
Syntax
HRESULT Remove(
long lIndex
);
Parameters
lIndex
Type: long
A long value that specifies the index of the outbound routing rule to remove from the collection. Valid values for this parameter are in the range from 1 to n, where n is the number of rules returned by a call to the IFaxOutboundRoutingRules::get_Count method.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
The default outbound routing rule cannot be removed.
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 |