<html> <head> <title>Interface XFunctionAccess</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="XFunctionAccess-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">sheet</a> :: </p> </td> </tr> <tr> <td class="title">interface XFunctionAccess</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows generic access to all spreadsheet functions. </dd> <dt><b>See also</b></dt> <dd><a href="FunctionAccess.html">FunctionAccess</a></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="#callFunction">callFunction</a></td> <td class="imsum_right">calls a function and returns the result of the call. </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="callFunction" class="membertitle">callFunction</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>callFunction</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] sequence< any ></td> <td valign="bottom"> aArguments )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::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>calls a function and returns the result of the call. </dd> <dt><b>Parameter aName</b></dt> <dd>the (programmatic) name of the function. </dd> <dt><b>Parameter aArguments</b></dt> <dd>the arguments for the function call. <p>Each element must be of one of the following types:</p> <dl> <dt><code>long</code> or <code>double</code></dt> <dd>for a numeric value.</dd> <dt><code>string</code></dt> <dd>for a textual value.</dd> <dt><code>long[][]</code> or <code>double[][]</code></dt> <dd>for an array of numeric values.</dd> <dt><code>string[][]</code></dt> <dd>for an array of textual values.</dd> <dt><code>any[][]</code></dt> <dd>for a mixed array, where each element must be of <b>void</b>, <code>long</code>, <code>double</code> or <code>string</code> type.</dd> <dt>::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/XCellRange.html">XCellRange</a></dt> <dd>for a <a href="SheetCellRange.html">SheetCellRange</a> object that contains the data.</dd> </dl> </dd> <dt><b>Returns</b></dt> <dd>the result of the function call. <p>Possible types for the result are:</p> <dl> <dt><b>void</b></dt> <dd>if no result is available.</dd> <dt><code>double</code></dt> <dd>for a numeric result.</dd> <dt><code>string</code></dt> <dd>for a textual result.</dd> <dt><code>any[][]</code></dt> <dd>for an array result, containing <code>double</code> and <code>string</code> values.</dd> </dl> </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if the named function does not exist. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> if the function can not be called with these arguments. </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>