<html> <head> <title>Global Functions in Namespace in Sourcefile module.h</title> <link rel="stylesheet" type="text/css" href="../cpp.css"> </head> <body> <div id="adc-cppref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0"> <tr align="center" valign="top"> <td class="navimain"> <a href="../index.html">Overview</a> </td> <td class="navimain"> <a href="index.html">Namespace</a> </td> <td class="navimainnone"> Class </td> <td class="navimain"> <a href="../index-files/index-1.html">Index</a> </td> <td class="navimain"> <a href="../help.html">Help</a> </td> </tr> </table> <table class="navisub" cellpadding="0" cellspacing="3"></table> <hr> <div class="title"><h2>Global Functions in Global Namespace C++<br> in Sourcefile module.h</h2> </div><hr> <dl class="member"> <dt class="member"><a name="osl_getAsciiFunctionSymbol-831"> </a>osl_getAsciiFunctionSymbol</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> oslGenericFunction <strong>osl_getAsciiFunctionSymbol</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-oslModule.html">oslModule</a> </td> <td> Module,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>pSymbol );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Lookup the specified function symbol name. </dd> <dt>Description</dt> <dd> osl_getAsciiFunctionSymbol is an alternative function for osl_getFunctionSymbol. It expects the C-style function name string to contain ascii characters only. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">Module</td> <td><pre> [in] a module handle as returned by osl_loadModule or osl_getModuleHandle </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pFunctionSymbolName</td> <td><pre> [in] Name of the function that will be looked up. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> <dl> <dt>Function address.</dt> <dd>on success</dd> <dt>NULL</dt> <dd>lookup failed or the parameter are invalid.</dd> </dl> </dd> <dt>See Also</dt> <dd>osl_getModuleHandle <br> osl_getFunctionSymbol <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="osl_getFunctionSymbol-830"> </a>osl_getFunctionSymbol</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> oslGenericFunction <strong>osl_getFunctionSymbol</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-oslModule.html">oslModule</a> </td> <td> Module,</td> </tr> <tr> <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> <td>ustrFunctionSymbolName );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Lookup the specified function symbol name. </dd> <dt>Description</dt> <dd> osl_getFunctionSymbol is an alternative function for osl_getSymbol. Use Function pointer as symbol address to conceal type conversion. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">Module</td> <td><pre> [in] the handle of the Module. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">ustrFunctionSymbolName</td> <td><pre> [in] Name of the function that will be looked up. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> <dl> <dt>Function address.</dt> <dd>on success</dd> <dt>NULL</dt> <dd>lookup failed or the parameter are invalid.</dd> </dl> </dd> <dt>See Also</dt> <dd>osl_getSymbol <br> osl_getAsciiFunctionSymbol <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="osl_getModuleHandle-827"> </a>osl_getModuleHandle</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Bool.html">sal_Bool</a> <strong>osl_getModuleHandle</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> <td> pModuleName,</td> </tr> <tr> <td><a href="t-oslModule.html">oslModule</a> *</td> <td>pResult );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Retrieve the handle of an already loaded module. </dd> <dt>Description</dt> <dd> 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. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pModuleName</td> <td><pre> [in] denotes the name of the module to search for. Ignored on Unix </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pResult</td> <td><pre> [out] a pointer to a oslModule that is updated with the requested module handle on success. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> 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. </dd> <dt>See Also</dt> <dd>osl_getFunctionSymbol <br> osl_getAsciiFunctionSymbol <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="osl_getModuleURLFromAddress-832"> </a>osl_getModuleURLFromAddress</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Bool.html">sal_Bool</a> <strong>osl_getModuleURLFromAddress</strong>(</dt> <dd><table class="param-table"> <tr> <td>void * </td> <td> pv,</td> </tr> <tr> <td><a href="t-rtl_uString.html">rtl_uString</a> * *</td> <td>pustrURL );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Lookup URL of module which is mapped at the specified address. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pv</td> <td><pre>specifies an address in the process memory space. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pustrURL</td> <td><pre>receives the URL of the module that is mapped at pv. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd>sal_True on success, sal_False if no module can be found at the specified address. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="osl_getModuleURLFromFunctionAddress-833"> </a>osl_getModuleURLFromFunctionAddress</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Bool.html">sal_Bool</a> <strong>osl_getModuleURLFromFunctionAddress</strong>(</dt> <dd><table class="param-table"> <tr> <td>oslGenericFunction </td> <td> pf,</td> </tr> <tr> <td><a href="t-rtl_uString.html">rtl_uString</a> * *</td> <td>pustrFunctionURL );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Lookup URL of module which is mapped at the specified function address. </dd> <dt>Description</dt> <dd> osl_getModuleURLFromFunctionAddress is an alternative function for osl_getModuleURLFromAddress. Use Function pointer as symbol address to conceal type conversion. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pf</td> <td><pre> [in] function address in oslGenericFunction format. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pustrFunctionURL</td> <td><pre> [out] receives the URL of the module that is mapped at pf. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> <dl> <dt>sal_True</dt> <dd>on success</dd> <dt>sal_False</dt> <dd>no module can be found at the specified function address or parameter is somewhat invalid.</dd> </dl> </dd> <dt>See Also</dt> <dd>osl_getModuleURLFromAddress <br> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="osl_getSymbol-829"> </a>osl_getSymbol</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void * <strong>osl_getSymbol</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-oslModule.html">oslModule</a> </td> <td> Module,</td> </tr> <tr> <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> <td>strSymbolName );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>lookup the specified symbol name. </dd> <dt>Return</dt> <dd>address of the symbol or NULL if lookup failed. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="osl_loadModule-825"> </a>osl_loadModule</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-oslModule.html">oslModule</a> <strong>osl_loadModule</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> <td> strModuleName,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>nRtldMode );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Load a shared library or module. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">strModuleName</td> <td><pre>denotes the name of the module to be loaded. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd>NULL if the module could not be loaded, otherwise a handle to the module. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="osl_loadModuleRelative-826"> </a>osl_loadModuleRelative</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-oslModule.html">oslModule</a> <strong>osl_loadModuleRelative</strong>(</dt> <dd><table class="param-table"> <tr> <td>oslGenericFunction </td> <td> baseModule,</td> </tr> <tr> <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> <td>relativePath,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>mode );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Load a module located relative to some other module. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">baseModule</td> <td><pre> must point to a function that is part of the code of some loaded module; must not be NULL. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">relativePath</td> <td><pre> a relative URL; must not be NULL. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">mode</td> <td><pre> the SAL_LOADMODULE_xxx flags. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> a non-NULL handle to the loaded module, or NULL if an error occurred. </dd> <dt>Since </dt> <dd>UDK 3.2.8</dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="osl_unloadModule-828"> </a>osl_unloadModule</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>osl_unloadModule</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-oslModule.html">oslModule</a> </td> <td> Module );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Release the module </dd> </dl> </dd> </dl> <hr> <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-cppref" --> </body> </html>