<html>
<head>
<title>Interface XScript</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="XScript-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">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">script</a> :: <a href="module-ix.html" class="namechain">provider</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XScript</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>This interface represents an invokable script or UNO function.
</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="#invoke">invoke</a></td>
<td class="imsum_right">invoke the script or function represented by the implementing
object
</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="invoke" class="membertitle">invoke</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>invoke</b>(</td>
<td valign="top">[in] sequence< any ></td>
<td valign="bottom"> aParams,</td>
</tr>
<tr>
<td/><td valign="top">[out] sequence< short ></td>
<td valign="bottom"> aOutParamIndex,</td>
</tr>
<tr>
<td/><td valign="top">[out] sequence< any ></td>
<td valign="bottom"> aOutParam )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="ScriptFrameworkErrorException.html">ScriptFrameworkErrorException</a>,<br>
::com::sun::star::<a href="../../reflection/module-ix.html">reflection</a>::<a href="../../reflection/InvocationTargetException.html">InvocationTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>invoke the script or function represented by the implementing
object
</dd>
<dt><b>Parameter aParams</b></dt>
<dd>all parameters; pure, out params are undefined in sequence,
i.e., the value has to be ignored by the callee
</dd>
<dt><b>Parameter aOutParamIndex</b></dt>
<dd>out indices, indicating the position of the out or inout
parameters in the list of arguments to the script
</dd>
<dt><b>Parameter aOutParam</b></dt>
<dd>out parameters<p>
For example, if the script had the signature<br>
<code>long foo( [inout] string a, [in] string b, [out] string c )</code>
<br> the call would look like<br>
<code>bar.invoke( {"foo", "foo2", "this-is-ignored" }, aOutParamIndex, aOutParam);</code>
<br> and after the call the out sequences would contain<br>
<pre>
aOutParamIndex={0,2};
aOutParam={"string from a", "string from c"};
</pre>
</dd>
<dt><b>Returns</b></dt>
<dd>the value returned from the function being invoked
</dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::reflection::InvocationTargetException
if and error occurs while attempting to invoke a script the information is captured. If the error or exception is generated by the script itself it is wrapped as either ScriptErrorRaisedException or ScriptExceptionRaisedException or ScriptingFrameworkErrorException are wrapped as ScriptFrameworkErrorExceptions.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
5134
