Edit

IXpsOMDictionary::GetIndex method (xpsobjectmodel.h)

  • Article

Gets the index of an IXpsOMShareable interface from the dictionary.

Syntax

HRESULT GetIndex(
  [in]          IXpsOMShareable *entry,
  [out, retval] UINT32          *index
);

Parameters

[in] entry

The IXpsOMShareable interface pointer to be found in the dictionary.

[out, retval] index

The zero-based index of entry in the dictionary.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code Description
S_OK
 The method succeeded.
E_INVALIDARG
The object referenced by entry is not in the dictionary.

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

See also

IXpsOMDictionary

IXpsOMShareable

XML Paper Specification