The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Global Functions in Global Namespace C++
in Sourcefile module.h


osl_getAsciiFunctionSymbol
extern "C"
oslGenericFunction osl_getAsciiFunctionSymbol(
oslModule Module,
const sal_Char * pSymbol );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Lookup the specified function symbol name.
Description
osl_getAsciiFunctionSymbol is an alternative function for osl_getFunctionSymbol. It expects the C-style function name string to contain ascii characters only.
Parameters
Module
    [in] a module handle as returned by osl_loadModule or osl_getModuleHandle

    
pFunctionSymbolName
    [in] Name of the function that will be looked up. 
   
    
Return
Function address.
on success
NULL
lookup failed or the parameter are invalid.
See Also
osl_getModuleHandle
osl_getFunctionSymbol

osl_getFunctionSymbol
extern "C"
oslGenericFunction osl_getFunctionSymbol(
oslModule Module,
rtl_uString * ustrFunctionSymbolName );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Lookup the specified function symbol name.
Description
osl_getFunctionSymbol is an alternative function for osl_getSymbol. Use Function pointer as symbol address to conceal type conversion.
Parameters
Module
    [in] the handle of the Module.

    
ustrFunctionSymbolName
    [in] Name of the function that will be looked up.
   
    
Return
Function address.
on success
NULL
lookup failed or the parameter are invalid.
See Also
osl_getSymbol
osl_getAsciiFunctionSymbol

osl_getModuleHandle
extern "C"
sal_Bool osl_getModuleHandle(
rtl_uString * pModuleName,
oslModule * pResult );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Retrieve the handle of an already loaded module.
Description
This function can be used to search for a function symbol in the process address space. Do not use the returned handle as an argument to osl_unloadModule. On Unix platforms, pModuleName gets ignored and the special handle RTLD_DEFAULT is returned.
Parameters
pModuleName
    [in] denotes the name of the module to search for. Ignored on Unix
    
    
pResult
    [out] a pointer to a oslModule that is updated with the requested module handle
    on success.
    
    
Return
sal_True if the module handle could be retrieved and has been copied to *pResult. sal_False if the module has not been loaded yet.
See Also
osl_getFunctionSymbol
osl_getAsciiFunctionSymbol

osl_getModuleURLFromAddress
extern "C"
sal_Bool osl_getModuleURLFromAddress(
void * pv,
rtl_uString * * pustrURL );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Lookup URL of module which is mapped at the specified address.
Parameters
pv
specifies an address in the process memory space.
pustrURL
receives the URL of the module that is mapped at pv.
Return
sal_True on success, sal_False if no module can be found at the specified address.

osl_getModuleURLFromFunctionAddress
extern "C"
sal_Bool osl_getModuleURLFromFunctionAddress(
oslGenericFunction pf,
rtl_uString * * pustrFunctionURL );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Lookup URL of module which is mapped at the specified function address.
Description
osl_getModuleURLFromFunctionAddress is an alternative function for osl_getModuleURLFromAddress. Use Function pointer as symbol address to conceal type conversion.
Parameters
pf
    [in] function address in oslGenericFunction format.
           
    
pustrFunctionURL
    [out] receives the URL of the module that is mapped at pf.
   
    
Return
sal_True
on success
sal_False
no module can be found at the specified function address or parameter is somewhat invalid.
See Also
osl_getModuleURLFromAddress

osl_getSymbol
extern "C"
void * osl_getSymbol(
oslModule Module,
rtl_uString * strSymbolName );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
lookup the specified symbol name.
Return
address of the symbol or NULL if lookup failed.

osl_loadModule
extern "C"
oslModule osl_loadModule(
rtl_uString * strModuleName,
sal_Int32 nRtldMode );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Load a shared library or module.
Parameters
strModuleName
denotes the name of the module to be loaded.
Return
NULL if the module could not be loaded, otherwise a handle to the module.

osl_loadModuleRelative
extern "C"
oslModule osl_loadModuleRelative(
oslGenericFunction baseModule,
rtl_uString * relativePath,
sal_Int32 mode );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Load a module located relative to some other module.
Parameters
baseModule
    must point to a function that is part of the code of some loaded module;
    must not be NULL.

    
relativePath
    a relative URL; must not be NULL.

    
mode
    the SAL_LOADMODULE_xxx flags.

    
Return
a non-NULL handle to the loaded module, or NULL if an error occurred.
Since
UDK 3.2.8

osl_unloadModule
extern "C"
void osl_unloadModule(
oslModule Module );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Release the module

Top of Page

Apache Software Foundation

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

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