Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: script :: provider ::
unpublished | interface XScript |
Usage Restrictions not published 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 > | aParams,
| [out] sequence< short > | aOutParamIndex,
| [out] sequence< any > | aOutParam )
raises( | ScriptFrameworkErrorException, ::com::sun::star::reflection::InvocationTargetException );
  Description invoke the script or function represented by the implementing object Parameter aParams all parameters; pure, out parameters 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::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 ScriptFrameworkErrorException are wrapped as ScriptFrameworkErrorExceptions.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.