<html>
<head>
<title>Global Functions in Namespace in Sourcefile environment.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 environment.h</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="uno_Environment_enter-3089"> </a>uno_Environment_enter</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_Environment_enter</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> * </td>
<td> pEnv );</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><pre>Enter an environment explicitly.
</pre></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">pEnv</td>
<td><pre><pre>the environment to enter; NULL leaves all environments
</pre></pre></td>
</tr>
</table>
</dd>
<dt>Since </dt>
<dd>UDK 3.2.7</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_Environment_invoke-3088"> </a>uno_Environment_invoke</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_Environment_invoke</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> * </td>
<td> pEnv,</td>
</tr>
<tr>
<td>uno_EnvCallee *</td>
<td>pCallee,</td>
</tr>
<tr>
<td>...</td>
<td> );</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><pre>Invoke the passed function in the given environment.
</pre></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">pEnv</td>
<td><pre><pre>the target environment
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pCallee</td>
<td><pre><pre>the function to call
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">...</td>
<td><pre><pre>the parameters passed to the function
</pre></pre></td>
</tr>
</table>
</dd>
<dt>Since </dt>
<dd>UDK 3.2.7</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_Environment_invoke_v-3087"> </a>uno_Environment_invoke_v</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_Environment_invoke_v</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> * </td>
<td> pEnv,</td>
</tr>
<tr>
<td>uno_EnvCallee *</td>
<td>pCallee,</td>
</tr>
<tr>
<td>va_list *</td>
<td>pParam );</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><pre>Invoke the passed function in the given environment.
</pre></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">pEnv</td>
<td><pre><pre>the target environment
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pCallee</td>
<td><pre><pre>the function to call
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pParam</td>
<td><pre><pre>the parameter pointer passed to the function
</pre></pre></td>
</tr>
</table>
</dd>
<dt>Since </dt>
<dd>UDK 3.2.7</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_Environment_isValid-3090"> </a>uno_Environment_isValid</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
int <strong>uno_Environment_isValid</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> * </td>
<td> pEnv,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>pReason );</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><pre>Check if a particular environment is currently valid, so
that objects of that environment might be called.
</pre></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">pEnv</td>
<td><pre><pre>the environment
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rtl_uString</td>
<td><pre><pre>** pReason the reason, if it is not valid
</pre></pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd><pre>1 == valid, 0 == invalid
</pre></dd>
<dt>Since </dt>
<dd>UDK 3.2.7</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_createEnvironment-3083"> </a>uno_createEnvironment</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_createEnvironment</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> * * </td>
<td> ppEnv,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pEnvDcp,</td>
</tr>
<tr>
<td>void *</td>
<td>pContext );</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><pre>Creates an environment. The new environment is anonymous (NOT publicly registered/ accessible).
</pre></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">ppEnv</td>
<td><pre><pre>out parameter of environment; given environment will be released
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pEnvDcp</td>
<td><pre><pre>descriptor of environment
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pContext</td>
<td><pre><pre>context pointer (e.g., to distinguish java vm); set 0 if not needed
</pre></pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_dumpEnvironment-3084"> </a>uno_dumpEnvironment</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_dumpEnvironment</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>void * </td>
<td> stream,</td>
</tr>
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> *</td>
<td>pEnv,</td>
</tr>
<tr>
<td>const <a href="t-sal_Char.html">sal_Char</a> *</td>
<td>pFilter );</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><pre>Dumps out environment information, i.e. registered interfaces.
</pre></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">stream</td>
<td><pre><pre>output stream (FILE *)
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pEnv</td>
<td><pre><pre>environment to be dumped
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pFilter</td>
<td><pre><pre>if not null, filters output
</pre></pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_dumpEnvironmentByName-3085"> </a>uno_dumpEnvironmentByName</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_dumpEnvironmentByName</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>void * </td>
<td> stream,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pEnvDcp,</td>
</tr>
<tr>
<td>const <a href="t-sal_Char.html">sal_Char</a> *</td>
<td>pFilter );</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><pre>Dumps out environment information, i.e. registered interfaces.
</pre></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">stream</td>
<td><pre><pre>output stream (FILE *)
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pEnvDcp</td>
<td><pre><pre>descritpro of environment to be dumped
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pFilter</td>
<td><pre><pre>if not null, filters output
</pre></pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_getCurrentEnvironment-3086"> </a>uno_getCurrentEnvironment</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_getCurrentEnvironment</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> * * </td>
<td> ppEnv,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pTypeName );</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>Description</dt>
<dd><pre>Returns the current Environment.
In case no Environment has explicitly been entered, a purpose free
default environment gets returned (e.g. the "uno" or "gcc3" Environment).
</pre></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">ppEnv</td>
<td><pre><pre>inout parameter; a given environment will be released
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pTypeName</td>
<td><pre><pre>the optional type of the environment, falls back to "uno"
</pre></pre></td>
</tr>
</table>
</dd>
<dt>Since </dt>
<dd>UDK 3.2.7</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_getEnvironment-3081"> </a>uno_getEnvironment</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_getEnvironment</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> * * </td>
<td> ppEnv,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pEnvDcp,</td>
</tr>
<tr>
<td>void *</td>
<td>pContext );</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><pre>Gets a specific environment. If the specified environment does not exist, then a default one
is created and registered. The environment revokes itself on last release() call.
</pre></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">ppEnv</td>
<td><pre><pre>inout parameter of environment; given environment will be released
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pEnvDcp</td>
<td><pre><pre>descriptor of environment
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pContext</td>
<td><pre><pre>some context pointer (e.g., to distinguish java vm; set 0 if not needed)
</pre></pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="uno_getRegisteredEnvironments-3082"> </a>uno_getRegisteredEnvironments</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>uno_getRegisteredEnvironments</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-uno_Environment.html">uno_Environment</a> * * * </td>
<td> pppEnvs,</td>
</tr>
<tr>
<td><a href="t-sal_Int32.html">sal_Int32</a> *</td>
<td>pnLen,</td>
</tr>
<tr>
<td>uno_memAlloc</td>
<td>memAlloc,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pEnvDcp );</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><pre>Gets all specified environments. Caller has to release returned environments and free allocated
memory.
</pre></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">pppEnvs</td>
<td><pre><pre>out param; pointer to array of environments
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pnLen</td>
<td><pre><pre>out param; length of array
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">memAlloc</td>
<td><pre><pre>function for allocating memory that is passed back
</pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pEnvDcp</td>
<td><pre><pre>descriptor of environments; 0 defaults to all
</pre></pre></td>
</tr>
</table>
</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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
9085
