IXpsOMNameCollection::GetAt method

Gets the name string that is stored at a specified location in the collection.

Syntax

HRESULT GetAt(
  [in]          UINT32 index,
  [out, retval] LPWSTR *name
);

Parameters

  • index [in]
    The zero-based index of the collection that contains the name string to be obtained.

  • name [out, retval]
    The name string at the location specified by index.

Return value

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Remarks

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

This method allocates the memory used by the string that is returned in name. If name is not NULL, use the CoTaskMemFree function to free the memory.

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

IXpsOMNameCollection

Working with XPS OM Collection Interfaces

XML Paper Specification