Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: reflection ::

interface XIdlArray
Description
Reflects an IDL sequence and provides dynamic access to instances of that sequence. This interface supports widening conversion when getting or setting elements. @attention Although the name of this interface denotes arrays, sequences are meant. Don't be obfuscated, arrays are not supported by UNO!

Methods' Summary
realloc Rellocates the length of the sequence instance.  
getLen Returns the length of the given sequence.  
get Returns element at given index.  
set Sets a new value at given index.  
Methods' Details
realloc
void
realloc( [inout] any  array,
[in] long  length )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Rellocates the length of the sequence instance.
Parameter array
sequence instance @length new length of sequence
getLen
long
getLen( [in] any  array )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Returns the length of the given sequence.
Parameter array
sequence instance
Returns
length of sequence
get
any
get( [in] any  aArray,
[in] long  nIndex )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description
Returns element at given index.
Parameter aArray
sequence instance
Parameter nIndex
index
Returns
value
Throws
IllegalArgumentException if the specified object is not a sequence 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 sequence.
set
void
set( [inout] any  aArray,
[in] long  nIndex,
[in] any  aNewValue )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description
Sets a new value at given index.
Parameter aArray
sequence instance
Parameter nIndex
index
Parameter aNewValue
new value to be set
Throws
IllegalArgumentException if the specified object is not a sequence 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 sequence.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.