| <html> |
| <head> |
| <title>Global Functions in Namespace in Sourcefile bootstrap.h</title> |
| <style> h1 { font-size:20pt; margin-top:3pt; margin-bottom:7pt; } |
| h2 { font-family:"Arial"; font-size:16pt; margin-top:3pt; margin-bottom:5pt; } |
| h3 { font-size:13pt; margin-top:2pt; margin-bottom:3pt; } |
| h4 { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dl { margin-top:1pt; margin-bottom:1pt; } |
| dl.member { margin-top:1pt; margin-bottom:1pt; background-color:#eeeeff; } |
| dt { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dt.member { font-size:13pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dt.simple { font-size:10pt; font-weight:normal; margin-top:2pt; margin-bottom:1pt; } |
| dd { font-size:10pt; margin-top:1pt; margin-bottom:1pt; } |
| dd.member { font-size:10pt; margin-top:1pt; margin-bottom:1pt; background-color:#ffffff; } |
| p { font-size:10pt; margin-top:3pt; margin-bottom:1pt; } |
| pre { font-family: Times, serif; font-size:10pt; margin-top:1pt; margin-bottom:1pt; } |
| tr { font-size:10pt; } |
| td { font-size:10pt; } |
| </style> |
| |
| <meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8"> |
| </head> |
| <body bgcolor="#ffffff"> |
| <a name="_top_"> </a> |
| <table border="0" cellpadding="1" cellspacing="0"> |
| <tr align="center" valign="top"> |
| <td bgcolor="#eeeeff"> <a href="../index.html" alt><font family="Arial" color="#000000" size="+1"><b>Overview</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <a href="index.html" alt><font family="Arial" color="#000000" size="+1"><b>Namespace</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <font family="Arial" color="#000000" size="+1">Class</font> </td> |
| <td bgcolor="#eeeeff"> <a href="../index-files/index-1.html" alt><font family="Arial" color="#000000" size="+1"><b>Index</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <a href="../help.html" alt><font family="Arial" color="#000000" size="+1"><b>Help</b></font></a> </td> |
| </tr> |
| </table> |
| <table cellpadding="0" cellspacing="3"></table> |
| <hr> |
| <div align="center" style="background-color:#ccccff; line-height:26pt;"><h2>Global Functions in Global Namespace C++<br> |
| in Sourcefile bootstrap.h</h2> |
| </div><hr> |
| <dl class="member"> |
| <dt class="member"><a name="rtl_bootstrap_args_close-377"> </a> |
| rtl_bootstrap_args_close</dt> |
| <dd class="member"><dl> |
| <dt class="simple">extern "C"<br> |
| void <strong>rtl_bootstrap_args_close</strong>(</dt> |
| <dd><table> |
| <tr> |
| <td><a href="t-rtlBootstrapHandle.html">rtlBootstrapHandle</a> </td> |
| <td> handle );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd>Closes a boostrap agument container. |
| </dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">handle</td> |
| <td><pre>The handle got by <code>rtl_bootstrap_args_open()</code> |
| </pre></td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="rtl_bootstrap_args_open-123"> </a> |
| rtl_bootstrap_args_open</dt> |
| <dd class="member"><dl> |
| <dt class="simple">extern "C"<br> |
| <a href="t-rtlBootstrapHandle.html">rtlBootstrapHandle</a> <strong>rtl_bootstrap_args_open</strong>(</dt> |
| <dd><table> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> pIniName );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd>Opens a bootstrap argument container. |
| </dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pIniName</td> |
| <td><pre>The name of the ini-file to use, if <code>NULL</code> defaults |
| to the excutables name |
| </pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd>Handle for a boostrap argument container |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="rtl_bootstrap_get-376"> </a> |
| rtl_bootstrap_get</dt> |
| <dd class="member"><dl> |
| <dt class="simple">extern "C"<br> |
| <a href="t-sal_Bool.html">sal_Bool</a> <strong>rtl_bootstrap_get</strong>(</dt> |
| <dd><table> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> pName,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * *</td> |
| <td>ppValue,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> |
| <td>pDefault );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">ppValue</td> |
| <td><pre>out parameter. Contains always a valid rtl_uString pointer. |
| </pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pName</td> |
| <td><pre> The name of the bootstrap setting to be retrieved. |
| </pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pDefault</td> |
| <td><pre> maybe NULL. If once the default is |
| returned, successive calls always return this |
| default value, even when called with different |
| defaults. |
| |
| </pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><code>sal_True</code>, when a value could be retrieved successfully, |
| <code>sal_False</code>, when none of the 4 methods gave a value. ppValue |
| then contains ane empty string. |
| When a pDefault value is given, the function returns always |
| <code>sal_True</code>. |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="rtl_bootstrap_get_from_handle-378"> </a> |
| rtl_bootstrap_get_from_handle</dt> |
| <dd class="member"><dl> |
| <dt class="simple">extern "C"<br> |
| <a href="t-sal_Bool.html">sal_Bool</a> <strong>rtl_bootstrap_get_from_handle</strong>(</dt> |
| <dd><table> |
| <tr> |
| <td><a href="t-rtlBootstrapHandle.html">rtlBootstrapHandle</a> </td> |
| <td> handle,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> |
| <td>pName,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * *</td> |
| <td>ppValue,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> |
| <td>pDefault );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">handle</td> |
| <td><pre>The handle got by <code>rtl_bootstrap_args_open()</code> |
| </pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pName</td> |
| <td><pre>The name of the variable to be retrieved |
| </pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">ppValue</td> |
| <td><pre>The result of the retrieval. *ppValue may be null in case of failure. |
| </pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pDefault</td> |
| <td><pre>The default value for the retrieval, may be <code>NULL</code> |
| |
| </pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd>The status of the retrieval, <code>sal_True</code> on success. |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="rtl_bootstrap_get_iniName_from_handle-379"> </a> |
| rtl_bootstrap_get_iniName_from_handle</dt> |
| <dd class="member"><dl> |
| <dt class="simple">extern "C"<br> |
| void <strong>rtl_bootstrap_get_iniName_from_handle</strong>(</dt> |
| <dd><table> |
| <tr> |
| <td><a href="t-rtlBootstrapHandle.html">rtlBootstrapHandle</a> </td> |
| <td> handle,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * *</td> |
| <td>ppIniName );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd>Returns the name of the inifile associated with this handle. |
| |
| </dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">ppIniName</td> |
| <td><pre>contains after the call the name of the ini-filename. |
| </pre></td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="rtl_bootstrap_setIniFileName-123"> </a> |
| rtl_bootstrap_setIniFileName</dt> |
| <dd class="member"><dl> |
| <dt class="simple">extern "C"<br> |
| void <strong>rtl_bootstrap_setIniFileName</strong>(</dt> |
| <dd><table> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> pName );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd>may be called by an application to set an ini-filename. |
| |
| </dd> |
| <dt>Description</dt> |
| <dd> <p> |
| Must be called before rtl_bootstrap_get(). May not be called twice. |
| If it is never called, a the filename executable.ini (win) |
| or execuablerc (unx) is assumed. |
| |
| </dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pName</td> |
| <td><pre>Name of the inifile with path but WITHOUT |
| suffix (.ini or rc) |
| </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 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</p> |
| </body> |
