<html> <head> <title>Interface XIdlArray</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XIdlArray-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">reflection</a> :: </p> </td> </tr> <tr> <td class="title">interface XIdlArray</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>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! </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#realloc">realloc</a></td> <td class="imsum_right">Rellocates the length of the sequence instance. </td> </tr> <tr> <td class="imsum_left"><a href="#getLen">getLen</a></td> <td class="imsum_right">Returns the length of the given sequence. </td> </tr> <tr> <td class="imsum_left"><a href="#get">get</a></td> <td class="imsum_right">Returns element at given index. </td> </tr> <tr> <td class="imsum_left"><a href="#set">set</a></td> <td class="imsum_right">Sets a new value at given index. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="realloc" class="membertitle">realloc</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>realloc</b>(</td> <td valign="top">[inout] any</td> <td valign="bottom"> array,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> length )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Rellocates the length of the sequence instance. </dd> <dt><b>Parameter array</b></dt> <dd>sequence instance @length new length of sequence </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLen" class="membertitle">getLen</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getLen</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> array )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the length of the given sequence. </dd> <dt><b>Parameter array</b></dt> <dd>sequence instance </dd> <dt><b>Returns</b></dt> <dd>length of sequence </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="get" class="membertitle">get</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>get</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> aArray,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/ArrayIndexOutOfBoundsException.html">ArrayIndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns element at given index. </dd> <dt><b>Parameter aArray</b></dt> <dd>sequence instance </dd> <dt><b>Parameter nIndex</b></dt> <dd>index </dd> <dt><b>Returns</b></dt> <dd>value </dd> <dt><b>Throws</b></dt> <dd>IllegalArgumentException if the specified object is not a sequence or if the specified object is null </dd> <dt><b>Throws</b></dt> <dd>ArrayIndexOutOfBoundsException if the specified index argument is negative, or if it is greater than or equal to the length of the specified sequence. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="set" class="membertitle">set</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>set</b>(</td> <td valign="top">[inout] any</td> <td valign="bottom"> aArray,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nIndex,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> aNewValue )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/ArrayIndexOutOfBoundsException.html">ArrayIndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Sets a new value at given index. </dd> <dt><b>Parameter aArray</b></dt> <dd>sequence instance </dd> <dt><b>Parameter nIndex</b></dt> <dd>index </dd> <dt><b>Parameter aNewValue</b></dt> <dd>new value to be set </dd> <dt><b>Throws</b></dt> <dd>IllegalArgumentException if the specified object is not a sequence or if the specified object is null </dd> <dt><b>Throws</b></dt> <dd>ArrayIndexOutOfBoundsException if the specified index argument is negative, or if it is greater than or equal to the length of the specified sequence. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>