generic-library/msgpack
1
0
Fork 0
mirror of https://github.com/msgpack/msgpack-c.git synced 2025-04-23 08:52:32 +02:00
Code Issues Projects Releases Wiki Activity
msgpack/c/group__msgpack__unpack.html
Takatoshi Kondo 96d587c87d Updated doc to 2.1.3
2017-06-30 11:05:26 +09:00

187 lines
9.9 KiB
HTML
Raw Blame History

<!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>MessagePack for C: Deserializer</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MessagePack for C
</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="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Deserializer<div class="ingroups"><a class="el" href="group__msgpack.html">MessagePack C</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga3b69128f26c3d3fd8cd3510c1020ee7c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpack.html#ga3b69128f26c3d3fd8cd3510c1020ee7c">msgpack_unpacked</a></td></tr>
<tr class="separator:ga3b69128f26c3d3fd8cd3510c1020ee7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga0762f1a4aaddf2935d985b22ec9d71be"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpack.html#ga0762f1a4aaddf2935d985b22ec9d71be">msgpack_unpack_return</a> { <br />
&#160;&#160;<a class="el" href="group__msgpack__unpack.html#gga0762f1a4aaddf2935d985b22ec9d71bea9bffb61ac05d5e3158fd809beb3a575f">MSGPACK_UNPACK_SUCCESS</a> = 2,
<a class="el" href="group__msgpack__unpack.html#gga0762f1a4aaddf2935d985b22ec9d71bea850dc1b4e0c7c38cc17241a0a810bf12">MSGPACK_UNPACK_EXTRA_BYTES</a> = 1,
<a class="el" href="group__msgpack__unpack.html#gga0762f1a4aaddf2935d985b22ec9d71bea48229cf8b7bc17baa59dc03e7e3503de">MSGPACK_UNPACK_CONTINUE</a> = 0,
<a class="el" href="group__msgpack__unpack.html#gga0762f1a4aaddf2935d985b22ec9d71bea3388543fa1a9b5ee2db023140dc50c08">MSGPACK_UNPACK_PARSE_ERROR</a> = -1,
<br />
&#160;&#160;<a class="el" href="group__msgpack__unpack.html#gga0762f1a4aaddf2935d985b22ec9d71bea6a3df31394025ebf818545298f4b177c">MSGPACK_UNPACK_NOMEM_ERROR</a> = -2
<br />
}</td></tr>
<tr class="separator:ga0762f1a4aaddf2935d985b22ec9d71be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3f4937f11c48264f292dd077f6c20eb9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="group__msgpack__unpack.html#ga0762f1a4aaddf2935d985b22ec9d71be">msgpack_unpack_return</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpack.html#ga3f4937f11c48264f292dd077f6c20eb9">msgpack_unpack_next</a> (<a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> *result, const char *<a class="el" href="unpack__template_8h.html#a8f64897c7ccc5c13f276d1d07c4e7095">data</a>, size_t <a class="el" href="unpack__template_8h.html#ac16e956eac9f5c3180afa8e80d4f098c">len</a>, size_t *<a class="el" href="unpack__template_8h.html#a6685eca32e2433680e732402740608c5">off</a>)</td></tr>
<tr class="separator:ga3f4937f11c48264f292dd077f6c20eb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga3b69128f26c3d3fd8cd3510c1020ee7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3b69128f26c3d3fd8cd3510c1020ee7c">&#9670;&nbsp;</a></span>msgpack_unpacked</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> <a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga0762f1a4aaddf2935d985b22ec9d71be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0762f1a4aaddf2935d985b22ec9d71be">&#9670;&nbsp;</a></span>msgpack_unpack_return</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__msgpack__unpack.html#ga0762f1a4aaddf2935d985b22ec9d71be">msgpack_unpack_return</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0762f1a4aaddf2935d985b22ec9d71bea9bffb61ac05d5e3158fd809beb3a575f"></a>MSGPACK_UNPACK_SUCCESS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga0762f1a4aaddf2935d985b22ec9d71bea850dc1b4e0c7c38cc17241a0a810bf12"></a>MSGPACK_UNPACK_EXTRA_BYTES&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga0762f1a4aaddf2935d985b22ec9d71bea48229cf8b7bc17baa59dc03e7e3503de"></a>MSGPACK_UNPACK_CONTINUE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga0762f1a4aaddf2935d985b22ec9d71bea3388543fa1a9b5ee2db023140dc50c08"></a>MSGPACK_UNPACK_PARSE_ERROR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga0762f1a4aaddf2935d985b22ec9d71bea6a3df31394025ebf818545298f4b177c"></a>MSGPACK_UNPACK_NOMEM_ERROR&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga3f4937f11c48264f292dd077f6c20eb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f4937f11c48264f292dd077f6c20eb9">&#9670;&nbsp;</a></span>msgpack_unpack_next()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="group__msgpack__unpack.html#ga0762f1a4aaddf2935d985b22ec9d71be">msgpack_unpack_return</a> msgpack_unpack_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *&#160;</td>
<td class="paramname"><em>off</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink