This repository was archived by the owner on Apr 21, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgroup__consolecapi.html
289 lines (278 loc) · 15.9 KB
/
group__consolecapi.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EOS.IO: Console C API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EOS.IO
 <span id="projectnumber">DAWN3.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Console C API<div class="ingroups"><a class="el" href="group__contractdev.html">Smart Contract API Reference</a> » <a class="el" href="group__consoleapi.html">Console API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>C API to log/print text messages.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa99be0cc1b9e5cbbc2b12a43537e7ed3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__consolecapi.html#gaa99be0cc1b9e5cbbc2b12a43537e7ed3">prints</a> (const char *cstr)</td></tr>
<tr class="memdesc:gaa99be0cc1b9e5cbbc2b12a43537e7ed3"><td class="mdescLeft"> </td><td class="mdescRight">Prints string. <a href="#gaa99be0cc1b9e5cbbc2b12a43537e7ed3">More...</a><br /></td></tr>
<tr class="separator:gaa99be0cc1b9e5cbbc2b12a43537e7ed3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga63ff8a7c0b046968ab2864df7284c910"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__consolecapi.html#ga63ff8a7c0b046968ab2864df7284c910">prints_l</a> (const char *cstr, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> len)</td></tr>
<tr class="memdesc:ga63ff8a7c0b046968ab2864df7284c910"><td class="mdescLeft"> </td><td class="mdescRight">Prints string. <a href="#ga63ff8a7c0b046968ab2864df7284c910">More...</a><br /></td></tr>
<tr class="separator:ga63ff8a7c0b046968ab2864df7284c910"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga23902e1572b43c290fed01d9ae736a78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__consolecapi.html#ga23902e1572b43c290fed01d9ae736a78">printi</a> (<a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> value)</td></tr>
<tr class="memdesc:ga23902e1572b43c290fed01d9ae736a78"><td class="mdescLeft"> </td><td class="mdescRight">Prints value as a 64 bit unsigned integer. <a href="#ga23902e1572b43c290fed01d9ae736a78">More...</a><br /></td></tr>
<tr class="separator:ga23902e1572b43c290fed01d9ae736a78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ac41ae1c31cf87a4adc14d9edb3e6a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__consolecapi.html#ga0ac41ae1c31cf87a4adc14d9edb3e6a5">printi128</a> (const <a class="el" href="group__types.html#ga396787e5ec029b1205bd3e4cd9763e7d">uint128_t</a> *value)</td></tr>
<tr class="memdesc:ga0ac41ae1c31cf87a4adc14d9edb3e6a5"><td class="mdescLeft"> </td><td class="mdescRight">Prints value as a 128 bit unsigned integer. <a href="#ga0ac41ae1c31cf87a4adc14d9edb3e6a5">More...</a><br /></td></tr>
<tr class="separator:ga0ac41ae1c31cf87a4adc14d9edb3e6a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae533b1ec1f098222339ad296a7d882c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__consolecapi.html#gae533b1ec1f098222339ad296a7d882c8">printd</a> (<a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> value)</td></tr>
<tr class="memdesc:gae533b1ec1f098222339ad296a7d882c8"><td class="mdescLeft"> </td><td class="mdescRight">Prints value as double. <a href="#gae533b1ec1f098222339ad296a7d882c8">More...</a><br /></td></tr>
<tr class="separator:gae533b1ec1f098222339ad296a7d882c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9ec6a2d163a27b98984065d55fb41475"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__consolecapi.html#ga9ec6a2d163a27b98984065d55fb41475">printn</a> (<a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> name)</td></tr>
<tr class="memdesc:ga9ec6a2d163a27b98984065d55fb41475"><td class="mdescLeft"> </td><td class="mdescRight">Prints a 64 bit names as base32 encoded string. <a href="#ga9ec6a2d163a27b98984065d55fb41475">More...</a><br /></td></tr>
<tr class="separator:ga9ec6a2d163a27b98984065d55fb41475"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d51117e490e3d0309d821b2d9dd55a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__consolecapi.html#ga5d51117e490e3d0309d821b2d9dd55a5">printhex</a> (void *data, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> datalen)</td></tr>
<tr class="separator:ga5d51117e490e3d0309d821b2d9dd55a5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae533b1ec1f098222339ad296a7d882c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae533b1ec1f098222339ad296a7d882c8">◆ </a></span>printd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void printd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints value as double </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Value</td><td>of double (interpreted as 64 bit unsigned integer) to be printed</td></tr>
</table>
</dd>
</dl>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> double_value = <a class="code" href="group__mathcapi.html#gad67af06a6b0e9dbbf3be05d6bf99257c">double_div</a>( <a class="code" href="group__mathcapi.html#gaec506d4ee77526e67ab5f2a8ef54f2b5">i64_to_double</a>(5), <a class="code" href="group__mathcapi.html#gaec506d4ee77526e67ab5f2a8ef54f2b5">i64_to_double</a>(10) );</div><div class="line"><a class="code" href="group__consolecapi.html#gae533b1ec1f098222339ad296a7d882c8">printd</a>(double_value); <span class="comment">// Output: 0.5</span></div></div><!-- fragment -->
</div>
</div>
<a id="ga5d51117e490e3d0309d821b2d9dd55a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d51117e490e3d0309d821b2d9dd55a5">◆ </a></span>printhex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void printhex </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> </td>
<td class="paramname"><em>datalen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga23902e1572b43c290fed01d9ae736a78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga23902e1572b43c290fed01d9ae736a78">◆ </a></span>printi()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void printi </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints value as a 64 bit unsigned integer </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Value</td><td>of 64 bit unsigned integer to be printed</td></tr>
</table>
</dd>
</dl>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="group__consolecapi.html#ga23902e1572b43c290fed01d9ae736a78">printi</a>(1e+18); <span class="comment">// Output: 1000000000000000000</span></div></div><!-- fragment -->
</div>
</div>
<a id="ga0ac41ae1c31cf87a4adc14d9edb3e6a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ac41ae1c31cf87a4adc14d9edb3e6a5">◆ </a></span>printi128()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void printi128 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__types.html#ga396787e5ec029b1205bd3e4cd9763e7d">uint128_t</a> * </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints value as a 128 bit unsigned integer </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>128 bit integer to be printed</td></tr>
</table>
</dd>
</dl>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="group__types.html#ga396787e5ec029b1205bd3e4cd9763e7d">uint128_t</a> large_int(87654323456);</div><div class="line"><a class="code" href="group__consolecapi.html#ga0ac41ae1c31cf87a4adc14d9edb3e6a5">printi128</a>(large_int); <span class="comment">// Output: 87654323456</span></div></div><!-- fragment -->
</div>
</div>
<a id="ga9ec6a2d163a27b98984065d55fb41475"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ec6a2d163a27b98984065d55fb41475">◆ </a></span>printn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void printn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints a 64 bit names as base32 encoded string </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Value</td><td>of 64 bit names to be printed</td></tr>
</table>
</dd>
</dl>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="group__consolecapi.html#ga9ec6a2d163a27b98984065d55fb41475">printn</a>(<a class="code" href="group__types.html#gaf9c1edb0e0da55ec6ba09f32f6839529">N</a>(abcde)); <span class="comment">// Output: abcde</span></div></div><!-- fragment -->
</div>
</div>
<a id="gaa99be0cc1b9e5cbbc2b12a43537e7ed3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa99be0cc1b9e5cbbc2b12a43537e7ed3">◆ </a></span>prints()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void prints </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cstr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints string </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cstr</td><td>- a null terminated string</td></tr>
</table>
</dd>
</dl>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="group__consolecapi.html#gaa99be0cc1b9e5cbbc2b12a43537e7ed3">prints</a>(<span class="stringliteral">"Hello World!"</span>); <span class="comment">// Output: Hello World!</span></div></div><!-- fragment -->
</div>
</div>
<a id="ga63ff8a7c0b046968ab2864df7284c910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga63ff8a7c0b046968ab2864df7284c910">◆ </a></span>prints_l()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void prints_l </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cstr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints string up to given length </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cstr</td><td>- pointer to string </td></tr>
<tr><td class="paramname">len</td><td>- len of string to be printed</td></tr>
</table>
</dd>
</dl>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="group__consolecapi.html#ga63ff8a7c0b046968ab2864df7284c910">prints_l</a>(<span class="stringliteral">"Hello World!"</span>, 5); <span class="comment">// Output: Hello</span></div></div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>