Sophie

Sophie

distrib > * > cooker > x86_64 > by-pkgid > 5fb1c39f9f9130a3cc01e8b1ffa5c0f8 > files > 9668

libreoffice-devel-3.5.4-4.x86_64.rpm

<html>
<head>
<title>Methods of Class Bootstrap</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">&nbsp;<a href="../../../index.html">Overview</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../index.html">Namespace</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../c-Bootstrap.html">Class</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../../index-files/index-1.html">Index</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../../help.html">Help</a>&nbsp;</td>
</tr>
</table>
<table class="navisub" cellpadding="0" cellspacing="3"></table>
<hr>
<div class="title"><h2>Methods of Class Bootstrap</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="Bootstrap-1459"> </a>Bootstrap</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>Bootstrap</strong>();</dt>
<dd><table class="param-table"></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="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>default ctor.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="Bootstrap-1460"> </a>Bootstrap</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>Bootstrap</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const <a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> iniName );</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="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Opens a bootstrap argment container
</dd>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_args_open-1691">rtl_bootstrap_args_open()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="~Bootstrap-1461"> </a>~Bootstrap</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>~Bootstrap</strong>();</dt>
<dd><table class="param-table"></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="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Closes a bootstrap argument container
</dd>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_args_close-1692">rtl_bootstrap_args_close()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getFrom-1462"> </a>getFrom</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../t-sal_Bool.html">sal_Bool</a> <strong>getFrom</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> sName,</td>
</tr>
<tr>
<td>::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>outValue ) const;</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="flagyes">YES</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieves a bootstrap argument.

</dd>
<dt>Description</dt>
<dd>            It is first tried to retrieve the value via the global function
            and second via the special bootstrap container.
            </dd>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_get_from_handle-1693">rtl_bootstrap_get_from_handle()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getFrom-1463"> </a>getFrom</dt>
<dd class="member"><dl>
<dt class="simple">void <strong>getFrom</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> sName,</td>
</tr>
<tr>
<td>::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>outValue,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>aDefault ) const;</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="flagyes">YES</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieves a bootstrap argument.

</dd>
<dt>Description</dt>
<dd>            It is first tried to retrieve the value via the global function
            and second via the special bootstrap container.
            </dd>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_get_from_handle-1693">rtl_bootstrap_get_from_handle()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getIniName-1464"> </a>getIniName</dt>
<dd class="member"><dl>
<dt class="simple">void <strong>getIniName</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> iniName ) const;</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="flagyes">YES</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieves the name of the underlying ini-file.
</dd>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_get_iniName_from_handle-1694">rtl_bootstrap_get_iniName_from_handle()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="expandMacrosFrom-1465"> </a>expandMacrosFrom</dt>
<dd class="member"><dl>
<dt class="simple">void <strong>expandMacrosFrom</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> macro ) const throw();</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="flagyes">YES</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Expands a macro using bootstrap variables.

</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">macro</td>
<td><pre>The macro to be expanded
        </pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getHandle-1467"> </a>getHandle</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../t-rtlBootstrapHandle.html">rtlBootstrapHandle</a> <strong>getHandle</strong>() throw();</dt>
<dd><table class="param-table"></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="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Provides the bootstrap internal handle.

</dd>
<dt>Return</dt>
<dd>bootstrap handle
        </dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="setIniFilename-1455"> </a>setIniFilename</dt>
<dd class="member"><dl>
<dt class="simple">static void <strong>setIniFilename</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> sFile );</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="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_setIniFileName-1687">rtl_bootstrap_setIniFileName()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="get-1456"> </a>get</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../t-sal_Bool.html">sal_Bool</a> <strong>get</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> sName,</td>
</tr>
<tr>
<td>::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>outValue );</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="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieves a bootstrap parameter
</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">sName</td>
<td><pre>name of the bootstrap value. case insensitive.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">outValue</td>
<td><pre>(out parameter). On success contains the value, otherwise
       an empty string.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>sal_False, if no value could be retrieved, otherwise sal_True
</dd>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_get-1688">rtl_bootstrap_get()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="get-1457"> </a>get</dt>
<dd class="member"><dl>
<dt class="simple">static void <strong>get</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> sName,</td>
</tr>
<tr>
<td>::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>outValue,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>aDefault );</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="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieves a bootstrap parameter

</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">sName</td>
<td><pre>name of the bootstrap value. case insensitive.
           </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">outValue</td>
<td><pre>(out parameter). Contains the value associated with sName.
           </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">aDefault</td>
<td><pre>if none of the other methods retrieved a value, outValue
                           is assigned to a Default.

           </pre></td>
</tr>
</table>
</dd>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_get-1688">rtl_bootstrap_get()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="set-1458"> </a>set</dt>
<dd class="member"><dl>
<dt class="simple">static void <strong>set</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> name,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>value ) throw();</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="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Sets a bootstrap parameter.

</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">pName</td>
<td><pre>                   name of bootstrap parameter
            </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pValue</td>
<td><pre>                   value of bootstrap parameter

            </pre></td>
</tr>
</table>
</dd>
<dt>See Also</dt>
<dd><a href="../../o-bootstrap.h.html#rtl_bootstrap_set-1689">rtl_bootstrap_set()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="expandMacros-1466"> </a>expandMacros</dt>
<dd class="member"><dl>
<dt class="simple">static void <strong>expandMacros</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> macro ) throw();</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="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Expands a macro using default bootstrap variables.

</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">macro</td>
<td><pre>The macro to be expanded
        </pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="encode-1468"> </a>encode</dt>
<dd class="member"><dl>
<dt class="simple">static ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> <strong>encode</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> value ) throw();</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="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Escapes special characters ("$" and "\").

</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">value</td>
<td><pre>            an arbitrary value

            </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
            the given value, with all occurrences of special characters ("$" and
            "\") escaped

            </dd>
<dt>Since </dt>
<dd>UDK 3.2.9</dd>
</dl>
</dd>
</dl>
<hr>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p>&nbsp;</p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p>

</div> <!-- id="adc-cppref" -->
</body>

</html>