:: drafts :: com :: sun :: star :: script :: provider ::
|
interface XScript |
- Base Hierarchy
::com::sun::star::uno::XInterface
|
+-XScript
|
- Description
-
This interface represents an invokable script or UNO function.
|
Methods' Summary |
invoke |
invoke the script or function represented by the implementing
object
|
Methods' Details |
invoke
any
invoke( |
[in] sequence< any >
[out] sequence< short >
[out] sequence< any >
raises(
|
aParams,
aOutParamIndex,
aOutParam )
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::script::CannotConvertException,
::com::sun::star::reflection::InvocationTargetException ); |
- Description
-
invoke the script or function represented by the implementing
object
- Parameter aParams
-
all parameters; pure, out params are undefined in sequence,
i.e., the value has to be ignored by the callee
- Parameter aOutParamIndex
-
out indices, indicating the position of the out or inout
parameters in the list of arguments to the script
- Parameter aOutParam
-
out parameters
For example, if the script had the signature
long foo( [inout] string a, [in] string b, [out] string c )
the call would look like
bar.invoke( {"foo", "foo2", "this-is-ignored" }, aOutParamIndex, aOutParam);
and after the call the out sequences would contain
aOutParamIndex={0,2};
aOutParam={"string from a", "string from c"};
- Returns
-
the value returned from the function being invoked
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if there is no matching script name
- Throws
- ::com::sun::star::script::CannotConvertException
if args do not match or cannot be converted the those
of the invokee
- Throws
- ::com::sun::star::reflection::InvocationTargetException
if the running script throws an exception this information is captured and rethrown as this exception type.
|
|
Top of Page
Copyright © 2003 Sun Microsystems, Inc.