IXpsOMDashCollection::RemoveAt method (xpsobjectmodel.h)

Article
02/22/2024

Removes and frees an XPS_DASH structure 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 XPS_DASH structure is to be removed and freed.

Return value

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Remarks

This method removes and frees the XPS_DASH structure referenced by the pointer at the location specified by index. After freeing the structure, this method compacts the collection by reducing by 1 the index of each pointer subsequent to index.

The figure that follows illustrates how the collection is changed by the RemoveAt method.

A figure that shows how RemoveAt removes an entry from the dash collection

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