| <html> |
| <head> |
| <title>Global Functions in Namespace in Sourcefile uri.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 uri.h</h2> |
| </div><hr> |
| <dl class="member"> |
| <dt class="member"><a name="rtl_getUriCharClass-485"> </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> |
| <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 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>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"> |
| <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_uriDecode-487"> </a> |
| rtl_uriDecode</dt> |
| <dd class="member"><dl> |
| <dt class="simple">extern "C"<br> |
| void <strong>rtl_uriDecode</strong>(</dt> |
| <dd><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 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>Decode (a part of) a URI. |
| |
| </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">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. |
| </pre></td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="rtl_uriEncode-486"> </a> |
| rtl_uriEncode</dt> |
| <dd class="member"><dl> |
| <dt class="simple">extern "C"<br> |
| void <strong>rtl_uriEncode</strong>(</dt> |
| <dd><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 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>Encode a text as (part of) a URI. |
| |
| </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">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. |
| </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> |
