interface XLibraryAccess in module com::sun::star::script::

(Global Index)

Syntax

interface XLibraryAccess : com::sun::star::uno::XInterface ;

Description

provides access to additional scripting code.

This code is organized in modules and these modules contain the functions. It is possible to get just the code from a function, but you can also get the whole code of a module with all functions in it.

Method Summary

isFunction

isValidPath

getModuleNames Return all module names which contain code. e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }

getModuleSource get the source code of a module.

getModuleCode Get the hole compiled code of a module.

getFunctionSource get the source code of a function.

getFunctionCode Get the compiled code of a function.

Method Details



isFunction

Syntax

boolean isFunction (
string aFunctionName );

Returns

true , if the function is accessible through this library; otherwise it returns false .

Parameter aFunctionName

the fully qualified name of a funtion. (e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate")

isValidPath

Syntax

boolean isValidPath (
string aPathName );

Returns

true if a fully qualified function name begins with this name.

Parameter aPathName

a part of a function name (e.g., "UtilLibrary").

getModuleNames

Syntax

sequence< string > getModuleNames ();

Description

Return all module names which contain code. e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }


getModuleSource

Syntax

string getModuleSource (
string aModulName );

Description

get the source code of a module.


getModuleCode

Syntax

sequence< byte > getModuleCode (
string aModuleName );

Description

Get the hole compiled code of a module.

Parameter ModuleName

the full qualified name of a module. (e.g., "UtilLibrary.ModuleDate")

Returns

an empty sequence, if this module is not found or the code is not compiled.

getFunctionSource

Syntax

string getFunctionSource (
string aFunctionName );

Description

get the source code of a function.


getFunctionCode

Syntax

sequence< byte > getFunctionCode (
string FunctionName );

Description

Get the compiled code of a function.

Parameter FunctionName

the full qualified name of a function. (e.g., "UtilLibrary.ModuleDate.Function.CurrentDate")

Returns

an empty sequence, if this function is not found.
Top of Page