Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

:: drafts :: com :: sun :: star :: script :: framework :: storage ::

interface XScriptStorageManager
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-XScriptStorageManager
Description
This interface provides access to data associated with a script

Methods' Summary
createScriptStorage create a ScriptStorage using the com::sun::star::ucb::XSimpleFileAccess passed as an argument, and return an ID for getting the associated ScriptStorage (Not currently supported)
createScriptStorageWithURI create a ScriptStorage using the com::sun::star::ucb::XSimpleFileAccess , and a string URL and return an ID for getting the associated ScriptStorage .
getScriptStorage get a ScriptStorage component using its scriptStorageID
getScriptStorageID get a ScriptStorage ID using storage URI
refreshScriptStorage refresh a storage component using its URI
Methods' Details
createScriptStorage
long
createScriptStorage(
 
[in] ::com::sun::star::ucb::XSimpleFileAccess
 
xSFA );

Description
create a ScriptStorage using the com::sun::star::ucb::XSimpleFileAccess passed as an argument, and return an ID for getting the associated ScriptStorage (Not currently supported)
Parameter xSFA
an implementation of XSimpleFileAccess that knows its own base URL and can thus take URLs relative to that base.
Returns
a long ScriptStorage ID, which can be used in the getScriptStorage method
createScriptStorageWithURI
long
createScriptStorageWithURI(
 
[in] ::com::sun::star::ucb::XSimpleFileAccess
[in] string
 
xSFA,
stringURI );

Description
create a ScriptStorage using the com::sun::star::ucb::XSimpleFileAccess , and a string URL and return an ID for getting the associated ScriptStorage .
Parameter xSFA
a standard implementation of XSimpleFileAccess
Parameter stringURI
a string URI to the head of the script storage
Returns
a long ScriptStorage ID, which can be used in the getScriptStorage method
getScriptStorage
::com::sun::star::uno::XInterface
getScriptStorage(
 
[in] long 

raises(

 
scriptStorageID ) 
::com::sun::star::uno::SecurityException );

Description
get a ScriptStorage component using its scriptStorageID
Parameter scriptStorageID
the long returned by one of the methods above. ID=0 is reserved for the application/share scripts, and ID=1 is reserved for the application/user scripts
Returns
an XInterface to a component that implements the ScriptStorage service
Throws
::com::sun::star::uno::SecurityException if permission to access this storage is denied
getScriptStorageID
long
getScriptStorageID(
 
[in] string
 
scriptStorageURI );

Description
get a ScriptStorage ID using storage URI
Parameter scriptStorageURI
the file URL for the document will retrieve storage id for the document, special treatment is reserved for the strings "USER"and "SHARE" which retrieve storage id for application/user application/share areas respectively.
Returns
a long ScriptStorage ID (-1 if no storage exists), which can be used in getScriptStorage method.
refreshScriptStorage
void
refreshScriptStorage(
 
[in] string
 
StringURI );

Description
refresh a storage component using its URI
Parameter StringURI
URI of storage area, for documents, url to document eg, file:///home/user/ADocument.sxw To refresh the storage for user or share area, use USER or SHARE respectively instead or a url.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.