UDK 3.2.7 C/C++ API Reference
Public Member Functions | Static Public Member Functions
osl::Module Class Reference

#include <module.hxx>

List of all members.

Public Member Functions

 Module ()
 Module (const ::rtl::OUString &strModuleName, sal_Int32 nRtldMode=SAL_LOADMODULE_DEFAULT)
 ~Module ()
sal_Bool load (const ::rtl::OUString &strModuleName, sal_Int32 nRtldMode=SAL_LOADMODULE_DEFAULT)
sal_Bool loadRelative (::oslGenericFunction baseModule,::rtl::OUString const &relativePath,::sal_Int32 mode=SAL_LOADMODULE_DEFAULT)
sal_Bool loadRelative (oslGenericFunction baseModule, char const *relativePath, sal_Int32 mode=SAL_LOADMODULE_DEFAULT)
void unload ()
sal_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

Static Public Member Functions

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

Constructor & Destructor Documentation

osl::Module::Module ( ) [inline]
osl::Module::Module ( const ::rtl::OUString strModuleName,
sal_Int32  nRtldMode = SAL_LOADMODULE_DEFAULT 
) [inline]
osl::Module::~Module ( ) [inline]

Member Function Documentation

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:
ustrFunctionSymbolName[in] Function name to be looked up.
Returns:
oslGenericFunction format function address
on success
NULL
lookup failed or parameter is somewhat invalid
See also:
getSymbol
oslGenericFunction osl::Module::getFunctionSymbol ( char const *  name) const [inline]
Since:
LibreOffice 3.5
void* osl::Module::getSymbol ( const ::rtl::OUString strSymbolName) [inline]
static sal_Bool osl::Module::getUrlFromAddress ( void *  addr,
::rtl::OUString libraryUrl 
) [inline, static]
static sal_Bool osl::Module::getUrlFromAddress ( oslGenericFunction  addr,
::rtl::OUString libraryUrl 
) [inline, static]

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:
addr[in] function address in oslGenericFunction format.
libraryUrl[in|out] receives the URL of the module.
Returns:
sal_True
on success
sal_False
can not get the URL from the specified function address or the parameter is invalid.
See also:
getUrlFromAddress
sal_Bool osl::Module::is ( ) const [inline]
sal_Bool osl::Module::load ( const ::rtl::OUString strModuleName,
sal_Int32  nRtldMode = SAL_LOADMODULE_DEFAULT 
) [inline]
sal_Bool osl::Module::loadRelative ( oslGenericFunction  baseModule,
char const *  relativePath,
sal_Int32  mode = SAL_LOADMODULE_DEFAULT 
) [inline]
Since:
LibreOffice 3.5
sal_Bool osl::Module::loadRelative ( ::oslGenericFunction  baseModule,
::rtl::OUString const &  relativePath,
::sal_Int32  mode = SAL_LOADMODULE_DEFAULT 
) [inline]
Since:
UDK 3.2.8
osl::Module::operator oslModule ( ) const [inline]
void osl::Module::unload ( ) [inline]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines