interface XIdlArray in module com::sun::star::reflection::

(Global Index)

Syntax

interface XIdlArray : com::sun::star::uno::XInterface ;

Description

provides methods to dynamically access arrays.

Array permits widening conversions to occur during a get or set operation, but throws an IllegalArgumentException if a narrowing conversion would occur.

See also

IdlClass
*

Method Summary

realloc Change the size of the array to the new size. If the new length is greater, the additional elements are default constructed, otherwise the elements are destructed.

getLen

get

set sets the value of the indexed component of the specified array object to the specified new value.

Method Details



realloc

Syntax

void realloc (
any array,
long length )
raises ( com::sun::star::lang::IllegalArgumentException );

Description

Change the size of the array to the new size. If the new length is greater, the additional elements are default constructed, otherwise the elements are destructed.


getLen

Syntax

long getLen (
any array )
raises ( com::sun::star::lang::IllegalArgumentException );

Description

Returns

the number of elements in the array.

get

Syntax

any get (
any aArray,
long nIndex )
raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description

Returns

the value of the indexed component in the specified array object.

Throws

IllegalArgumentException if the specified object is not an array or if the specified object is NULL .

Throws

ArrayIndexOutOfBoundsException if the specified index argument is negative, or if it is greater than or equal to the length of the specified array.

set

Syntax

void set (
any aArray,
long nIndex,
any aNewValue )
raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description

sets the value of the indexed component of the specified array object to the specified new value.

Top of Page