Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: loader ::

interface XImplementationLoader
Description
handles activation (loading) of a UNO component.
See also
::com::sun::star::registry::XImplementationRegistration
Developers Guide
AdvUNO - Implementation Loader

Methods' Summary
activate activates a concrete implementation within a component.  
writeRegistryInfo writes a list of all implementations hosted by this component into a registry key.  
Methods' Details
activate
::com::sun::star::uno::XInterface
activate( [in] string  implementationName,
[in] string  implementationLoaderUrl,
[in] string  locationUrl,
[in] ::com::sun::star::registry::XRegistryKey  xKey )
raises( CannotActivateFactoryException );

Description
activates a concrete implementation within a component.
Parameter implementationName
The name of the implementation, which shall be instantiated. The method XImplementationLoader::writeRegistryInfo writes a list of implementation names hosted by this component.
Parameter implementationLoaderUrl
specification bug, ignore this parameter, please pass an empty string.
Parameter locationUrl
Points to the location of the file containing the component (for instance a .jar-file or a shared library). This parameter should be in an URL format (= protocol:protocol-dependent-part). In case the string contains no leading "protocol:", the implementation in general assumes, that it is a relative file url.

Special loaders may define their own protocol (for instance an executable loader may need more than only one file url).

Parameter xKey
A registry which may be used to read static data previously written via XImplementationLoader::writeRegistryInfo(). The use of this parameter is deprecated.
Returns
returns a factory interface, which allows to create an instance of the concrete implementation. In general, the object supports a ::com::sun::star::lang::XSingleComponentFactory and the ::com::sun::star::lang::XServiceInfo interface. The XServiceInfo interface informs about the capabilities of the service implementation, not the factory itself.
writeRegistryInfo
boolean
writeRegistryInfo( [in] ::com::sun::star::registry::XRegistryKey  xKey,
[in] string  implementationLoaderUrl,
[in] string  locationUrl )
raises( ::com::sun::star::registry::CannotRegisterImplementationException );

Description
writes a list of all implementations hosted by this component into a registry key.

This method is called during registering a component.

Parameter xKey
The registry key, which shall be used to write for each implementation the implementation name plus a list of supported services.
Parameter implementationLoaderUrl
specification bug, ignore this parameter, please pass an empty string.
Parameter locationUrl
Points to the location of the file containing the component (for instance a .jar-file or a shared library). This parameter should be in an URL format (= protocol:protocol-dependent-part). In case the string contains no leading "protocol:", the implementation in general assumes, that it is a relative file url.

Special loaders may define their own protocol (for instance an executable loader may need more than only one file url).

See also
::com::sun::star::registry::XImplementationRegistration
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.