IXpsOMDictionary::GetIndex method

Gets the index of an IXpsOMShareable interface from the dictionary.

Syntax


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

Parameters

entry [in]

The IXpsOMShareable interface pointer to be found in the dictionary.

index [out, retval]

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 codeDescription
S_OK

The method succeeded.

E_INVALIDARG

The object referenced by entry is not in 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
IXpsOMShareable
XML Paper Specification

 

 

Show: