interface XIndexAccess in module com::sun::star::container::

(Global Index)

Syntax

interface XIndexAccess : com::sun::star::container::XElementAccess ;

Description

provides access to the elements of a collection through an index.

This interface should only be used if the data structure, itself, is indexed.

Method Summary

getCount

getByIndex

Method Details



getCount

Syntax

long getCount ();

Description

Returns

the number of elements.

getByIndex

Syntax

any getByIndex (
long Index )
raises ( com::sun::star::lang::IndexOutOfBoundsException , com::sun::star::lang::WrappedTargetException );

Description

Returns

the element at the specified index

Parameter Index

specifies the position in the array. The first index is 0.

Throws

com::sun::star::lang::IndexOutOfBoundException if the index is not valid.

Throws

com::sun::star::lang::WrappedTargetException If the implementation has internal reasons for exceptions, then wrap these in a WrappedTargetException exception.
Top of Page