IXpsOMGradientStopCollection::RemoveAt method (xpsobjectmodel.h)

Article
10/13/2021

Removes and releases an IXpsOMGradientStop interface pointer from a specified location in the collection.

Syntax

HRESULT RemoveAt(
  [in] UINT32 index
);

Parameters

[in] index

The zero-based index in the collection from which an IXpsOMGradientStop interface pointer is to be removed and released.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_INVALIDARG	The gradient stop collection has only two stops. A gradient stop collection must have at least two gradient stops, and removing the specified gradient stop would leave fewer than two gradient stops in the collection.

Remarks

This method releases the IXpsOMGradientStop interface referenced by the pointer at the location specified by index. After releasing the interface, this method compacts the collection by reducing by 1 the index of each pointer subsequent to index.

For more information about the collection methods, see Working with XPS OM Collection Interfaces.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	xpsobjectmodel.h