<html>
<head>
<title>Interface XInvocation</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="XInvocation-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">script</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XInvocation</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>gives access to an object's methods and properties.
Container access is available through
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexContainer.html">XIndexContainer</a>,
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameContainer.html">XNameContainer</a> and
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumerationAccess.html">XEnumerationAccess</a>.
</p>
</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="#getIntrospection">getIntrospection</a></td>
<td class="imsum_right">returns the introspection from this object or <b>NULL</b>
if the object does not provide this information.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#invoke">invoke</a></td>
<td class="imsum_right">provides access to methods exposed by an object.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setValue">setValue</a></td>
<td class="imsum_right">sets a value to the property with the specified name.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getValue">getValue</a></td>
<td class="imsum_right">returns the value of the property with the specified name.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#hasMethod">hasMethod</a></td>
<td class="imsum_right">returns <b>true</b> if the method with the specified name exists, else <b>false</b>.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#hasProperty">hasProperty</a></td>
<td class="imsum_right">returns <b>true</b> if the property with the specified name exists, else <b>false</b>.
</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="getIntrospection" class="membertitle">getIntrospection</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">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XIntrospectionAccess.html">XIntrospectionAccess</a></td>
</tr>
<tr>
<td valign="top"><b>getIntrospection</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the introspection from this object or <b>NULL</b>
if the object does not provide this information.
</dd>
</dl>
</td>
</tr>
</table>
</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] string</td>
<td valign="bottom"> aFunctionName,</td>
</tr>
<tr>
<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">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
<a href="CannotConvertException.html">CannotConvertException</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>provides access to methods exposed by an object.
</dd>
<dt><b>Parameter aParams</b></dt>
<dd>all parameters; pure out params are undefined in sequence,
the value has to be ignored by the callee
</dd>
<dt><b>Parameter aOutParamIndex</b></dt>
<dd>This sequence contains the indices of all parameters
that are specified as out or inout.
</dd>
<dt><b>Parameter aOutParam</b></dt>
<dd>This sequence contains the values of all parameters that
are specified as out or inout and corresponds with the
indices provided by the aOutParamIndex sequence.
Example: aOutParamIndex == { 1, 4 } means that
aOutParam[0] contains the out value of the aParams[1]
parameter and aOutParam[1] contains the out value of
the aParams[4] parameter.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setValue" class="membertitle">setValue</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>setValue</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> aPropertyName,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom"> aValue )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>,<br>
<a href="CannotConvertException.html">CannotConvertException</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>sets a value to the property with the specified name.
</dd>
<dd><p> If the underlying object implements an
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameContainer.html">XNameContainer</a>,
then this method will insert the value if there is no such
<var>aPropertyName</var>.
</p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getValue" class="membertitle">getValue</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>getValue</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> aPropertyName )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the value of the property with the specified name.
</dd>
<dt><b>Parameter aPropertyName</b></dt>
<dd>specifies the name of the property.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="hasMethod" class="membertitle">hasMethod</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>hasMethod</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> aName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns <b>true</b> if the method with the specified name exists, else <b>false</b>.
</dd>
<dd><p>This optimizes the calling sequence
( <a href="XInvocation.html">XInvocation</a>::<a href="XInvocation.html#hasMethod">hasMethod</a>,
<a href="XInvocation.html">XInvocation</a>::<a href="XInvocation.html#invoke">invoke</a> )!</p>
</dd>
<dt><b>Parameter aName</b></dt>
<dd>specifies the name of the method.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="hasProperty" class="membertitle">hasProperty</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>hasProperty</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> aName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns <b>true</b> if the property with the specified name exists, else <b>false</b>.
</dd>
<dd><p>This optimizes the calling sequence
( <a href="XInvocation.html">XInvocation</a>::<a href="XInvocation.html#hasProperty">hasProperty</a>,
<a href="XInvocation.html">XInvocation</a>::<a href="XInvocation.html#getValue">getValue</a> ) or
( <a href="XInvocation.html">XInvocation</a>::<a href="XInvocation.html#hasProperty">hasProperty</a>,
<a href="XInvocation.html">XInvocation</a>::<a href="XInvocation.html#setValue">setValue</a> )!
</dd>
<dt><b>Parameter aName</b></dt>
<dd>specifies the name of the property.
</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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4844
