IXpsOMDashCollection::InsertAt method (xpsobjectmodel.h)

Article
10/13/2021

Inserts an XPS_DASH structure at a specified location in the collection.

Syntax

HRESULT InsertAt(
  [in] UINT32         index,
  [in] const XPS_DASH *dash
);

Parameters

[in] index

The zero-based index in the collection where the structure that is referenced by dash is to be inserted.

[in] dash

A pointer to the XPS_DASH structure that is to be inserted at the location specified by index.

Return value

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

Remarks

At the location specified by index, this method inserts the XPS_DASH structure that is passed in dash. Prior to insertion, the structure in this and all subsequent locations is moved up by one index.

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

A figure that shows how InsertAt adds an entry to 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