IXpsOMDocumentCollection::InsertAt method

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

Syntax

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

Parameters

  • index [in]
    The zero-based index of the collection where the interface pointer that is passed in document is to be inserted.

  • document [in]
    The IXpsOMDocument interface pointer 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 IXpsOMDocument interface pointer that is passed in document. Prior to the insertion, the pointer in this and all subsequent locations is moved up by one index.

For more information about the collection methods, see Working with XPS OM Collection Interfaces.

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

See also

IXpsOMDocumentCollection

Working with XPS OM Collection Interfaces

IXpsOMDocument

XML Paper Specification