help/info/unichar2oct.html

   1 <!--
   2  Copyright (c) 2000-2015 Ericsson Telecom AB
   3
   4  All rights reserved. This program and the accompanying materials
   5  are made available under the terms of the Eclipse Public License v1.0
   6  which accompanies this distribution, and is available at
   7  http://www.eclipse.org/legal/epl-v10.html
   8  -->
   9 <html>
  10 <head>
  11 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  12 <meta http-equiv="Content-Language" content="en-us">
  13 <title>unichar2oct</title>
  14 </head>
  15 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  16 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  17   <tr>
  18     <td width=105 height=40><a href="https://projects.eclipse.org/projects/tools.titan"><img src="../images/titan_transparent.gif" border=0 width=105 height=40 align="left" alt="Titan"></a></td>
  19   </tr>
  20 </table>
  21 <table border="0" align="right" cellpadding="0" cellspacing="0">
  22   <tr>
  23     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  24     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  25     <td><a alt="previous" href="unichar2int.html"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a alt="next" href="union.html"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  27   </tr>
  28 </table>
  29 <p><br clear="all">
  30 </p>
  31 <hr>
  32 <h1>unichar2oct</h1>
  33 <hr align="left" width="75%">
  34 <p>This function converts an <b><font face="Courier New">universal charstring</font></b> value to an <b><font
  35   face="Courier New">octetstring</font></b> value.
  36   The first parameter is the universal characters to be encoded into octets. The second parameter is the type of the string encoding.
  37   The allowed values for string encoding are: UTF-8, UTF-8 BOM, UTF-16, UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE.
  38   If the second parameter is omitted the default encoding is UTF-8 (without the BOM). <b><font face="Courier New">unichar2oct</font></b> appends the Byte Order Mark (BOM) to the beginning of the returned octetstring, except for UTF-8 encoding. (In case of UTF-8, use UTF-8 BOM encoding to add the BOM.) The function <b><font face="Courier New">remove_bom</font></b> can be used to remove the BOM, if it is not needed.
  39 <hr align="left" width="50%">
  40 <p>Related keyword:</p>
  41 <ul>
  42   <li><b><a href="octetstring.html"><font face="Courier New" size="4" color="#003258"> octetstring</font></a></b></li>
  43   <li><b><a href="universal.html"><font face="Courier New" size="4" color="#003258"> universal</font></a></b></li>
  44   <li><b><a href="charstring.html"><font face="Courier New" size="4" color="#003258"> charstring</font></a></b></li>
  45   <li><b><a href="remove_bom.html"><font face="Courier New" size="4" color="#003258"> remove_bom</font></a></b></li>
  46 </ul>
  47 <hr align="left" width="50%">
  48 <div align="center">
  49 <center>
  50 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  51   <tr>
  52     <td width="100%">
  53     <h3 align="center"><font face="Courier New" color="#003258" size="5"><b>unichar2oct</b></font><font face="Courier New" color="#003258" size="5"><b>(</b></font><i>universal charstring [,charstring]</i><font
  54       face="Courier New" color="#003258" size="5"><b>) return octetstring</b></font></h3>
  55     </td>
  56   </tr>
  57 </table>
  58 </center>
  59 </div>
  60 <ul>
  61 </ul>
  62 <hr align="left" width="25%">
  63 <p>Example 1:</p>
  64 <p><font face="Courier New">const universal charstring c_ustr := "ÄÖÜäöü"; </font></p>
  65 <p><font face="Courier New">const octetstring c_result := unichar2oct(c_ustr, "UTF-16LE"); </font></p>
  66 <p>The constant called c_result will conatin the characters 'FFFE00C400D600DC00E400F600FC'O;
  67 <hr align="left" width="25%">
  68 </body>
  69 </html>