diff options
Diffstat (limited to 'include/osl/module.h')
| -rw-r--r-- | include/osl/module.h | 86 |
1 files changed, 39 insertions, 47 deletions
diff --git a/include/osl/module.h b/include/osl/module.h index fadd573dc0cd..9d1bbefa328a 100644 --- a/include/osl/module.h +++ b/include/osl/module.h @@ -56,6 +56,7 @@ extern "C" { typedef void* oslModule; /** Generic Function pointer type that will be used as symbol address. + @see osl_getFunctionSymbol. @see osl_getModuleURLFromFunctionAddress. */ @@ -64,34 +65,33 @@ typedef void ( SAL_CALL *oslGenericFunction )( void ); #ifndef DISABLE_DYNLOADING /** Load a shared library or module. - @param strModuleName denotes the name of the module to be loaded. - @param nRtldMode denotes the mode. - @return NULL if the module could not be loaded, otherwise a handle to the module. + + @param[in] strModuleName denotes the name of the module to be loaded. + @param[in] nRtldMode denotes the mode. + + @returns NULL if the module could not be loaded, otherwise a handle to the module. */ SAL_DLLPUBLIC oslModule SAL_CALL osl_loadModule(rtl_uString *strModuleName, sal_Int32 nRtldMode); /** Load a shared library or module. - @param pModuleName denotes the name of the module to be loaded. - @param nRtldMode denotes the mode. + + @param[in] pModuleName denotes the name of the module to be loaded. + @paramiin] nRtldMode denotes the mode. + @return NULL if the module could not be loaded, otherwise a handle to the module. + @since UDK 3.6 */ SAL_DLLPUBLIC oslModule SAL_CALL osl_loadModuleAscii(const sal_Char *pModuleName, sal_Int32 nRtldMode); /** Load a module located relative to some other module. - @param baseModule - must point to a function that is part of the code of some loaded module; - must not be NULL. - - @param relativePath - a relative URL; must not be NULL. - - @param mode - the SAL_LOADMODULE_xxx flags. + @param[in] baseModule must point to a function that is part of the code of some loaded module; + must not be NULL. + @param[in] relativePath a relative URL; must not be NULL. + @param[in] mode the SAL_LOADMODULE_xxx flags. - @return - a non-NULL handle to the loaded module, or NULL if an error occurred. + @return a non-NULL handle to the loaded module, or NULL if an error occurred. @since UDK 3.2.8 */ @@ -100,19 +100,13 @@ SAL_DLLPUBLIC oslModule SAL_CALL osl_loadModuleRelative( /** Load a module located relative to some other module. - @param baseModule - must point to a function that is part of the code of some loaded module; - must not be NULL. - - @param relativePath - a relative URL containing only ASCII (0x01--7F) characters; must not be - NULL. - - @param mode - the SAL_LOADMODULE_xxx flags. + @param[in] baseModule must point to a function that is part of the code of some loaded module; + must not be NULL. + @param[in] relativePath a relative URL containing only ASCII (0x01--7F) characters; + must not be NULL. + @param[in] mode the SAL_LOADMODULE_xxx flags. - @return - a non-NULL handle to the loaded module, or NULL if an error occurred. + @return a non-NULL handle to the loaded module, or NULL if an error occurred. @since LibreOffice 3.5 */ @@ -130,12 +124,10 @@ SAL_DLLPUBLIC oslModule SAL_CALL osl_loadModuleRelativeAscii( 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. - @param pModuleName - [in] denotes the name of the module to search for. Ignored on Unix - - @param pResult - [out] a pointer to a oslModule that is updated with the requested module handle - on success. + @param[in] pModuleName denotes the name of the module to search for. + @attention Ignored on Unix. + @param[out] pResult a pointer to a oslModule that is updated with the + requested module handle on success. @retval sal_True if the module handle could be retrieved and has been copied to *pResult. @retval sal_False if the module has not been loaded yet. @@ -154,7 +146,13 @@ SAL_DLLPUBLIC void SAL_CALL osl_unloadModule(oslModule Module); #endif /** lookup the specified symbol name. + + @param[in] Module the handle of the Module. + @param[in] strSymbolName Name of the function that will be looked up. + @return address of the symbol or NULL if lookup failed. + + @see osl_getFunctionSymbol */ SAL_DLLPUBLIC void* SAL_CALL osl_getSymbol( oslModule Module, rtl_uString *strSymbolName); @@ -163,11 +161,8 @@ SAL_DLLPUBLIC void* SAL_CALL osl_getSymbol( oslModule Module, rtl_uString *strSy osl_getFunctionSymbol is an alternative function for osl_getSymbol. Use Function pointer as symbol address to conceal type conversion. - @param Module - [in] the handle of the Module. - - @param ustrFunctionSymbolName - [in] Name of the function that will be looked up. + @param[in] Module the handle of the Module. + @param[in] ustrFunctionSymbolName Unicode name of the function that will be looked up. @retval function-address on success @retval NULL lookup failed or the parameter are invalid @@ -198,10 +193,10 @@ SAL_DLLPUBLIC oslGenericFunction SAL_CALL osl_getFunctionSymbol( SAL_DLLPUBLIC oslGenericFunction SAL_CALL osl_getAsciiFunctionSymbol( oslModule Module, const sal_Char *pSymbol ); - /** Lookup URL of module which is mapped at the specified address. - @param pv specifies an address in the process memory space. - @param pustrURL receives the URL of the module that is mapped at pv. + + @param[in] pv specifies an address in the process memory space. + @paramout] 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. */ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_getModuleURLFromAddress( @@ -212,11 +207,8 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_getModuleURLFromAddress( osl_getModuleURLFromFunctionAddress is an alternative function for osl_getModuleURLFromAddress. Use Function pointer as symbol address to conceal type conversion. - @param pf - [in] function address in oslGenericFunction format. - - @param pustrFunctionURL - [out] receives the URL of the module that is mapped at pf. + @param[in] pf function address in oslGenericFunction format. + @param[out] pustrFunctionURL receives the URL of the module that is mapped at pf. @retval sal_True on success @retval sal_False no module can be found at the specified function address or parameter is somewhat invalid |