IXpsOMDocumentCollection::SetAt method (xpsobjectmodel.h)

Article
02/22/2024

Replaces an IXpsOMDocument interface pointer at a specified location in the collection.

Syntax

HRESULT SetAt(
  [in] UINT32         index,
  [in] IXpsOMDocument *document
);

Parameters

[in] index

The zero-based index in the collection where an IXpsOMDocument interface pointer is to be replaced.

[in] document

The IXpsOMDocument interface pointer that will replace 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 releases the IXpsOMDocument interface referenced by the existing pointer, then writes the pointer that is passed in document.

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