IXpsOMDictionary::RemoveAt method

Removes and releases the entry from a specified location in the dictionary.

Syntax


HRESULT RemoveAt(
  [in] UINT32 index
);

Parameters

index [in]

The zero-based index in the dictionary from which an entry is to be removed and released.

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 interface referenced by the pointer. After releasing the interface, this method compacts the dictionary by reducing by 1 the index of each pointer subsequent to index.

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

A figure that shows how RemoveAt removes an entry from the dictionary

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

IXpsOMDictionary
XML Paper Specification

 

 

Show: