LibreOffice
LibreOffice 24.8 SDK C/C++ API Reference
 
Loading...
Searching...
No Matches
osl::Module Class Reference

#include <module.hxx>

Public Member Functions

 Module ()
 
 Module (const ::rtl::OUString &strModuleName, sal_Int32 nRtldMode=SAL_LOADMODULE_DEFAULT)
 
 ~Module ()
 
bool load (const ::rtl::OUString &strModuleName, sal_Int32 nRtldMode=SAL_LOADMODULE_DEFAULT)
 
bool loadRelative (::oslGenericFunction baseModule, ::rtl::OUString const &relativePath, ::sal_Int32 mode=SAL_LOADMODULE_DEFAULT)
 
bool loadRelative (oslGenericFunction baseModule, char const *relativePath, sal_Int32 mode=SAL_LOADMODULE_DEFAULT)
 
void unload ()
 
bool is () const
 
void * getSymbol (const ::rtl::OUString &strSymbolName)
 
oslGenericFunction getFunctionSymbol (const ::rtl::OUString &ustrFunctionSymbolName) const
 Get function address by the function name in the module.
 
oslGenericFunction getFunctionSymbol (char const *name) const
 
 operator oslModule () const
 
void release ()
 Release the module so that it will not be unloaded from the destructor.
 

Static Public Member Functions

static bool getUrlFromAddress (void *addr, ::rtl::OUString &libraryUrl)
 
static bool getUrlFromAddress (oslGenericFunction addr, ::rtl::OUString &libraryUrl)
 Get module URL from the specified function address in the module.
 

Constructor & Destructor Documentation

◆ Module() [1/2]

osl::Module::Module ( )
inline

◆ Module() [2/2]

osl::Module::Module ( const ::rtl::OUString & strModuleName,
sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT )
inline

◆ ~Module()

osl::Module::~Module ( )
inline

Member Function Documentation

◆ getFunctionSymbol() [1/2]

oslGenericFunction osl::Module::getFunctionSymbol ( char const * name) const
inline
Since
LibreOffice 3.5

◆ getFunctionSymbol() [2/2]

oslGenericFunction osl::Module::getFunctionSymbol ( const ::rtl::OUString & ustrFunctionSymbolName) const
inline

Get function address by the function name in the module.

getFunctionSymbol is an alternative function for getSymbol. Use Function pointer as symbol address to conceal type conversion.

Parameters
[in]ustrFunctionSymbolNameFunction name to be looked up.
Return values
oslGenericFunctionformat function address on success
NULLlookup failed or parameter is somewhat invalid
See also
getSymbol

◆ getSymbol()

void * osl::Module::getSymbol ( const ::rtl::OUString & strSymbolName)
inline

◆ getUrlFromAddress() [1/2]

static bool osl::Module::getUrlFromAddress ( oslGenericFunction addr,
::rtl::OUString & libraryUrl )
inlinestatic

Get module URL from the specified function address in the module.

Similar to getUrlFromAddress, but use a function address to get URL of the Module. Use Function pointer as symbol address to conceal type conversion.

Parameters
[in]addrfunction address in oslGenericFunction format.
[in,out]libraryUrlreceives the URL of the module.
Return values
trueon success
falsecan not get the URL from the specified function address or the parameter is invalid.
See also
getUrlFromAddress

◆ getUrlFromAddress() [2/2]

static bool osl::Module::getUrlFromAddress ( void * addr,
::rtl::OUString & libraryUrl )
inlinestatic

◆ is()

bool osl::Module::is ( ) const
inline

◆ load()

bool osl::Module::load ( const ::rtl::OUString & strModuleName,
sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT )
inline

◆ loadRelative() [1/2]

bool osl::Module::loadRelative ( ::oslGenericFunction baseModule,
::rtl::OUString const & relativePath,
::sal_Int32 mode = SAL_LOADMODULE_DEFAULT )
inline
Since
UDK 3.2.8

◆ loadRelative() [2/2]

bool osl::Module::loadRelative ( oslGenericFunction baseModule,
char const * relativePath,
sal_Int32 mode = SAL_LOADMODULE_DEFAULT )
inline
Since
LibreOffice 3.5

◆ operator oslModule()

osl::Module::operator oslModule ( ) const
inline

◆ release()

void osl::Module::release ( )
inline

Release the module so that it will not be unloaded from the destructor.

This instance returns to the state of a default-constructed instance again.

Since
LibreOffice 4.3

◆ unload()

void osl::Module::unload ( )
inline

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