IXRGradientStopCollection::Add (Compact 2013)

3/28/2014

This method adds an item to the end of the IXRGradientStopCollection collection and retrieves the index that indicates where it was added.

Syntax

virtual HRESULT STDMETHODCALLTYPE Add(
    __in IXRGradientStop* pObject,
    __out_opt int* pIndex
) = 0;

Parameters

  • pObject
    [in] Pointer to an IXRGradientStop object that represents an item to add to this collection.
  • pIndex
    [out] Optional. Pointer to an integer value that indicates the zero-based index that describes the location of the item added to this collection.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

Because an object cannot exist more than once in a visual tree, an item can occur only once in this object collection. If you attempt to add an item that already exists, the Add method will return XR_E_COLLECTION_ELEMENT_ALREADY_ASSOCIATED.

.NET Framework Equivalent

System.Windows.PresentationFrameworkCollection(T).Add

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRGradientStopCollection
IXRGradientBrush::GetGradientStops
IXRGradientBrush::SetGradientStops