<html>
<head>
<title>Global Functions in Namespace in Sourcefile uri.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 uri.h</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="rtl_getUriCharClass-1798"> </a>rtl_getUriCharClass</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
const <a href="t-sal_Bool.html">sal_Bool</a> * <strong>rtl_getUriCharClass</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_UriCharClass.html">rtl_UriCharClass</a> </td>
<td> eCharClass );</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>Map a predefined rtl_UriCharClass to a form usable by rtl_uriEncode().
</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">eCharClass</td>
<td><pre> Any valid member of rtl_UriCharClass.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
An array of 128 booleans, to be used in calls to rtl_uriEncode().
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="rtl_uriConvertRelToAbs-1801"> </a>rtl_uriConvertRelToAbs</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-sal_Bool.html">sal_Bool</a> <strong>rtl_uriConvertRelToAbs</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pBaseUriRef,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pRelUriRef,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>pResult,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>pException );</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>Convert a relative URI reference into an absolute one.
</dd>
<dt>Description</dt>
<dd> A URI reference is a URI plus an optional <"#" fragment> part.
This function uses the algorithm described in RFC 2396, section 5.2, with
the following clarifications: (1) Backwards-compatible relative URIs
starting with a scheme component (see RFC 2396, section 5.2, step 3) are not
supported. (2) Segments "." and ".." within the path of the base URI are
not considered special, RFC 2396 seems a bit unlcear about that point.
(3) Erroneous excess segments ".." within the path of the relative URI (if
it is indeed relative) are left intact, as the examples in RFC 2396,
section C.2, suggest. (4) If the relative URI is a reference to the
"current document," the "current document" is taken to be the base URI.
This function signals exceptions by returning false and letting pException
point to a message explaining the exception.
</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">pBaseUriRef</td>
<td><pre> An absolute, hierarchical URI reference that serves as the base URI. If it
has to be inspected (i.e., pRelUriRef is not an absolute URI already), and
if it either is not an absolute URI (i.e., does not begin with a
<scheme ":"> part) or has a path that is non-empty but does not start
with "/", an exception will be signaled.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pRelUriRef</td>
<td><pre> An URI reference that may be either absolute or relative. If it is
absolute, it will be returned unmodified (and it need not be hierarchical
then).
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pResult</td>
<td><pre> Returns an absolute URI reference. Must itself not be null, and must point
to either null or a valid string. If an exception is signalled, it is left
unchanged.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pException</td>
<td><pre> Returns an explanatory message in case an exception is signalled. Must
itself not be null, and must point to either null or a valid string. If no
exception is signalled, it is left unchanged.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
True if no exception is signalled, otherwise false.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="rtl_uriDecode-1800"> </a>rtl_uriDecode</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>rtl_uriDecode</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pText,</td>
</tr>
<tr>
<td><a href="t-rtl_UriDecodeMechanism.html">rtl_UriDecodeMechanism</a></td>
<td>eMechanism,</td>
</tr>
<tr>
<td><a href="t-rtl_TextEncoding.html">rtl_TextEncoding</a></td>
<td>eCharset,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</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>Decode (a part of) a URI.
</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">pText</td>
<td><pre> Any Unicode string. Must not be null. (If the input is indeed part of a
valid URI, this string will only contain a subset of the ASCII characters,
but this function also handles other Unicode characters properly.)
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">eMechanism</td>
<td><pre> The mechanism describing how the input text is translated into a Unicode
string.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">eCharset</td>
<td><pre> When the decode mechanism is rtl_UriDecodeWithCharset, all escape
sequences in the input text are interpreted as characters from this
charset. Those characters are translated to Unicode characters in the
resulting output, if possible.
When the decode mechanism is rtl_UriDecodeNone or rtl_UriDecodeToIuri,
this parameter is ignored (and is best specified as
RTL_TEXTENCODING_UTF8).
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pResult</td>
<td><pre> Returns a decoded representation of the input text. Must itself not be
null, and must point to either null or a valid string.
If the decode mechanism is rtl_UriDecodeStrict, and pText cannot be
converted to eCharset because it contains (encodings of) unmappable
characters (which implies that pText is not empty), then an empty string is
returned.
</pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="rtl_uriEncode-1799"> </a>rtl_uriEncode</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
void <strong>rtl_uriEncode</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pText,</td>
</tr>
<tr>
<td>const <a href="t-sal_Bool.html">sal_Bool</a> *</td>
<td>pCharClass,</td>
</tr>
<tr>
<td><a href="t-rtl_UriEncodeMechanism.html">rtl_UriEncodeMechanism</a></td>
<td>eMechanism,</td>
</tr>
<tr>
<td><a href="t-rtl_TextEncoding.html">rtl_TextEncoding</a></td>
<td>eCharset,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</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>Encode a text as (part of) a URI.
</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">pText</td>
<td><pre> Any Unicode string. Must not be null.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pCharClass</td>
<td><pre> A char class, represented as an array of 128 booleans (true means keep the
corresponding ASCII character unencoded, false means encode it). Must not
be null, and the boolean corresponding to the percent sign (0x25) must be
false. (See rtl_getUriCharClass() for a function mapping from
rtl_UriCharClass to such arrays.)
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">eMechanism</td>
<td><pre> The mechanism describing how escape sequences in the input text are
handled.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">eCharset</td>
<td><pre> When Unicode characters from the input text have to be written using
escape sequences (because they are either outside the ASCII range or do
not belong to the given char class), they are first translated into this
charset before being encoded using escape sequences.
Also, if the encode mechanism is rtl_UriEncodeCheckEscapes, all escape
sequences already present in the input text are interpreted as characters
from this charset.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pResult</td>
<td><pre> Returns an encoded representation of the input text. Must itself not be
null, and must point to either null or a valid string.
If the encode mechanism is rtl_UriEncodeStrict, and pText cannot be
converted to eCharset because it contains unmappable characters (which
implies that pText is not empty), then an empty string is returned.
</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 © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>
</div> <!-- id="adc-cppref" -->
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
9480
