help/info/log2str.html

   1 <!--
   2  Copyright (c) 2000-2016 Ericsson Telecom AB
   3  All rights reserved. This program and the accompanying materials
   4  are made available under the terms of the Eclipse Public License v1.0
   5  which accompanies this distribution, and is available at
   6  http://www.eclipse.org/legal/epl-v10.html
   7
   8  Contributors:
   9   Balasko, Jeno
  10 -->
  11 <html>
  12 <head>
  13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  14 <meta http-equiv="Content-Language" content="en-us">
  15 <title>log2str</title>
  16 </head>
  17 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  18 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  19   <tr>
  20     <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>
  21   </tr>
  22 </table>
  23 <table border="0" align="right" cellpadding="0" cellspacing="0">
  24   <tr>
  25     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  26     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  27     <td><a href="log.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  28     <td><a href="map.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  29   </tr>
  30 </table>
  31 <p><br clear="all">
  32 </p>
  33 <hr>
  34 <h1>log2str</h1>
  35 <hr align="left" width="75%">
  36 <p>The function log2str  can be used to log into charstring  instead of the log file.</p>
  37 <hr align="left" width="50%"/>
  38 <p>Related keyword:</p>
  39 <ul>
  40   <li><b><font face="Courier New" size="4" color="#003258"> <a href="log.html">log</a></font></b></li>
  41   <li><b><a href="charstring.html"><font face="Courier New" size="4" color="#003258">charstring</font></a></b></li>
  42 </ul>
  43 <hr align="left" width="50%">
  44 <div align="center">
  45 <center>
  46 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  47   <tr>
  48     <td width="100%">
  49     <h3 align="center">
  50         <font face="Courier New" color="#003258" size="5"><b>log2str ( ... ) return charstring"</b></font>
  51         </h3>
  52     </td>
  53   </tr>
  54 </table>
  55 </center>
  56 </div>
  57 <ul>
  58 This function can be parameterized in the same way as the log function.<br/>
  59 It returns a charstring value which contains the log string for all the provided parameters,
  60 but it does not contain the timestamp, severity and call stack information, thus the output does not depend on the runtime configuration file. <br/>
  61 The parameters are interpreted the same way as they are in the log function:
  62 their string values are identical to what the log statement writes to the log file. <br/>
  63 The extra information (timestamp, severity, call stack) not included in the output can be obtained by writing external functions
  64 which use the runtimeâ\80\99s Logger class to obtain the required data.
  65 </ul>
  66 <hr align="left" width="25%">
  67 <p><a HREF="../info/BNF.html#logstatement">BNF definition</a> of <font face="Courier New">log</font></p>
  68 </body>
  69 </html>