LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XModuleManager Interface Reference

can be used to identify office modules. More...

import"XModuleManager.idl";

Inheritance diagram for XModuleManager:
XInterface XModuleManager2 ModuleManager

Public Member Functions

string identify ([in] ::com::sun::star::uno::XInterface Module) raises (::com::sun::star::lang::IllegalArgumentException, UnknownModuleException )
 identifies the given module. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

can be used to identify office modules.

Since
OOo 2.0

Member Function Documentation

◆ identify()

identifies the given module.

This identifier can then be used at the service ModuleManager to get more information about this module.

For identification the interface com::sun::star::lang::XServiceInfo is requested on the given module. Because all module service registrations must be unique this value can be queried and checked against the configuration.

Since OOo 2.3.0 also the optional interface XModule will be used. If its exists it will be preferred.

Parameters
ModulePossible objects for this parameter can be the following one:
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the parameter Module is:
  • an empty one
  • or does not provide one of the needed interface XFrame, XController, XModel
  • or does not provide the needed interface XServiceInfo.
UnknownModuleExceptionif the given module could not be identified. Note: If the module represent a XFrame instance with does not contain a document, this exception is thrown too!
Returns
An identifier for the given module. Note: This value varies every time. Error will be transported by thrown exceptions!

The documentation for this interface was generated from the following file: