IXpsOMDashCollection::SetAt method

Article
06/01/2017

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

Syntax

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

Parameters

index [in]
The zero-based index in the collection where an XPS_DASH structure is to be replaced.
dash [in]
A pointer to the XPS_DASH structure that will replace the current contents 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 frees the existing XPS_DASH structure then replaces it with the structure that is passed in dash.

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

A figure that shows how SetAt changes an entry in the dash collection

Requirements

Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| Windows Store apps]
Header	Xpsobjectmodel.h
IDL	XpsObjectModel.idl

Share via