You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

json__util_8h.html 27 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.4"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>json-c: json_util.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr id="projectrow">
  20. <td id="projectalign">
  21. <div id="projectname">json-c<span id="projectnumber">&#160;0.18</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.9.4 -->
  30. <script type="text/javascript" src="menudata.js"></script>
  31. <script type="text/javascript" src="menu.js"></script>
  32. <script type="text/javascript">
  33. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  34. $(function() {
  35. initMenu('',false,false,'search.php','Search');
  36. });
  37. /* @license-end */
  38. </script>
  39. <div id="main-nav"></div>
  40. </div><!-- top -->
  41. <div class="header">
  42. <div class="summary">
  43. <a href="#define-members">Macros</a> &#124;
  44. <a href="#func-members">Functions</a> </div>
  45. <div class="headertitle"><div class="title">json_util.h File Reference</div></div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <p>Miscllaneous utility functions and macros.
  49. <a href="#details">More...</a></p>
  50. <table class="memberdecls">
  51. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
  52. Macros</h2></td></tr>
  53. <tr class="memitem:a3dde282dc23d0eaa3c4840df8dc262d4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a3dde282dc23d0eaa3c4840df8dc262d4">json_min</a>(a, b)&#160;&#160;&#160;((a) &lt; (b) ? (a) : (b))</td></tr>
  54. <tr class="separator:a3dde282dc23d0eaa3c4840df8dc262d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:a57d63d199d4b9ea40359253618951300"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a57d63d199d4b9ea40359253618951300">json_max</a>(a, b)&#160;&#160;&#160;((a) &gt; (b) ? (a) : (b))</td></tr>
  56. <tr class="separator:a57d63d199d4b9ea40359253618951300"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:a084b6afc8f7fbef88976aabe4aca7efd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a084b6afc8f7fbef88976aabe4aca7efd">JSON_FILE_BUF_SIZE</a>&#160;&#160;&#160;4096</td></tr>
  58. <tr class="separator:a084b6afc8f7fbef88976aabe4aca7efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. </table><table class="memberdecls">
  60. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  61. Functions</h2></td></tr>
  62. <tr class="memitem:a588aec4a89d4d4c9c6eb524036d6ecc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a588aec4a89d4d4c9c6eb524036d6ecc1">json_object_from_file</a> (const char *filename)</td></tr>
  63. <tr class="separator:a588aec4a89d4d4c9c6eb524036d6ecc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:afcf6a91c5f70ab38eab92d938c67475f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#afcf6a91c5f70ab38eab92d938c67475f">json_object_from_fd_ex</a> (int fd, int depth)</td></tr>
  65. <tr class="separator:afcf6a91c5f70ab38eab92d938c67475f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:aa07667602c9e92eb9bbc3e51c4dfd06d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#aa07667602c9e92eb9bbc3e51c4dfd06d">json_object_from_fd</a> (int fd)</td></tr>
  67. <tr class="separator:aa07667602c9e92eb9bbc3e51c4dfd06d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a486fc95fafe7cb91c58c7f6487036bc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a486fc95fafe7cb91c58c7f6487036bc5">json_object_to_file</a> (const char *filename, struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *obj)</td></tr>
  69. <tr class="separator:a486fc95fafe7cb91c58c7f6487036bc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a68a7385c555cf21797e361d1d4de3441"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a68a7385c555cf21797e361d1d4de3441">json_object_to_file_ext</a> (const char *filename, struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *obj, int flags)</td></tr>
  71. <tr class="separator:a68a7385c555cf21797e361d1d4de3441"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:afd492c120e359d2d75b67da96b580661"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#afd492c120e359d2d75b67da96b580661">json_object_to_fd</a> (int fd, struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *obj, int flags)</td></tr>
  73. <tr class="separator:afd492c120e359d2d75b67da96b580661"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ad69b0c53974fb6e503260b5b518151b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#ad69b0c53974fb6e503260b5b518151b3">json_util_get_last_err</a> (void)</td></tr>
  75. <tr class="separator:ad69b0c53974fb6e503260b5b518151b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a9d9a63936cdae6639b9cdd87fdd13506"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a9d9a63936cdae6639b9cdd87fdd13506">json_parse_int64</a> (const char *buf, <a class="el" href="json__inttypes_8h.html#a67a9885ef4908cb72ce26d75b694386c">int64_t</a> *retval)</td></tr>
  77. <tr class="separator:a9d9a63936cdae6639b9cdd87fdd13506"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a94c2340c1344d57f7aa067f2dd0407f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a94c2340c1344d57f7aa067f2dd0407f9">json_parse_uint64</a> (const char *buf, <a class="el" href="json__inttypes_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> *retval)</td></tr>
  79. <tr class="separator:a94c2340c1344d57f7aa067f2dd0407f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a3f0f0b8f29a41b47d62e6c867707be50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a3f0f0b8f29a41b47d62e6c867707be50">json_parse_double</a> (const char *buf, double *retval)</td></tr>
  81. <tr class="separator:a3f0f0b8f29a41b47d62e6c867707be50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a0ff86f1188508b9ce4e774be6a0b2674"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json__util_8h.html#a0ff86f1188508b9ce4e774be6a0b2674">json_type_to_name</a> (enum <a class="el" href="json__types_8h.html#ac75c61993722a9b8aaa44704072ec06c">json_type</a> o_type)</td></tr>
  83. <tr class="separator:a0ff86f1188508b9ce4e774be6a0b2674"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table>
  85. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  86. <div class="textblock"><p >Miscllaneous utility functions and macros. </p>
  87. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  88. <a id="a084b6afc8f7fbef88976aabe4aca7efd" name="a084b6afc8f7fbef88976aabe4aca7efd"></a>
  89. <h2 class="memtitle"><span class="permalink"><a href="#a084b6afc8f7fbef88976aabe4aca7efd">&#9670;&nbsp;</a></span>JSON_FILE_BUF_SIZE</h2>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">#define JSON_FILE_BUF_SIZE&#160;&#160;&#160;4096</td>
  95. </tr>
  96. </table>
  97. </div><div class="memdoc">
  98. </div>
  99. </div>
  100. <a id="a57d63d199d4b9ea40359253618951300" name="a57d63d199d4b9ea40359253618951300"></a>
  101. <h2 class="memtitle"><span class="permalink"><a href="#a57d63d199d4b9ea40359253618951300">&#9670;&nbsp;</a></span>json_max</h2>
  102. <div class="memitem">
  103. <div class="memproto">
  104. <table class="memname">
  105. <tr>
  106. <td class="memname">#define json_max</td>
  107. <td>(</td>
  108. <td class="paramtype">&#160;</td>
  109. <td class="paramname">a, </td>
  110. </tr>
  111. <tr>
  112. <td class="paramkey"></td>
  113. <td></td>
  114. <td class="paramtype">&#160;</td>
  115. <td class="paramname">b&#160;</td>
  116. </tr>
  117. <tr>
  118. <td></td>
  119. <td>)</td>
  120. <td></td><td>&#160;&#160;&#160;((a) &gt; (b) ? (a) : (b))</td>
  121. </tr>
  122. </table>
  123. </div><div class="memdoc">
  124. </div>
  125. </div>
  126. <a id="a3dde282dc23d0eaa3c4840df8dc262d4" name="a3dde282dc23d0eaa3c4840df8dc262d4"></a>
  127. <h2 class="memtitle"><span class="permalink"><a href="#a3dde282dc23d0eaa3c4840df8dc262d4">&#9670;&nbsp;</a></span>json_min</h2>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">#define json_min</td>
  133. <td>(</td>
  134. <td class="paramtype">&#160;</td>
  135. <td class="paramname">a, </td>
  136. </tr>
  137. <tr>
  138. <td class="paramkey"></td>
  139. <td></td>
  140. <td class="paramtype">&#160;</td>
  141. <td class="paramname">b&#160;</td>
  142. </tr>
  143. <tr>
  144. <td></td>
  145. <td>)</td>
  146. <td></td><td>&#160;&#160;&#160;((a) &lt; (b) ? (a) : (b))</td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. </div>
  151. </div>
  152. <h2 class="groupheader">Function Documentation</h2>
  153. <a id="aa07667602c9e92eb9bbc3e51c4dfd06d" name="aa07667602c9e92eb9bbc3e51c4dfd06d"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#aa07667602c9e92eb9bbc3e51c4dfd06d">&#9670;&nbsp;</a></span>json_object_from_fd()</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> * json_object_from_fd </td>
  160. <td>(</td>
  161. <td class="paramtype">int&#160;</td>
  162. <td class="paramname"><em>fd</em></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p >Create a JSON object from an already opened file descriptor, using the default maximum object depth. (JSON_TOKENER_DEFAULT_DEPTH)</p>
  168. <p >See <a class="el" href="json__util_8h.html#afcf6a91c5f70ab38eab92d938c67475f">json_object_from_fd_ex()</a> for details. </p>
  169. </div>
  170. </div>
  171. <a id="afcf6a91c5f70ab38eab92d938c67475f" name="afcf6a91c5f70ab38eab92d938c67475f"></a>
  172. <h2 class="memtitle"><span class="permalink"><a href="#afcf6a91c5f70ab38eab92d938c67475f">&#9670;&nbsp;</a></span>json_object_from_fd_ex()</h2>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> * json_object_from_fd_ex </td>
  178. <td>(</td>
  179. <td class="paramtype">int&#160;</td>
  180. <td class="paramname"><em>fd</em>, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype">int&#160;</td>
  186. <td class="paramname"><em>depth</em>&#160;</td>
  187. </tr>
  188. <tr>
  189. <td></td>
  190. <td>)</td>
  191. <td></td><td></td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p >Create a JSON object from already opened file descriptor.</p>
  196. <p >This function can be helpful, when you opened the file already, e.g. when you have a temp file. Note, that the fd must be readable at the actual position, i.e. use lseek(fd, 0, SEEK_SET) before.</p>
  197. <p >The depth argument specifies the maximum object depth to pass to <a class="el" href="json__tokener_8h.html#a9d9f1b78983dc1c68463f619b68b4563">json_tokener_new_ex()</a>. When depth == -1, JSON_TOKENER_DEFAULT_DEPTH is used instead.</p>
  198. <p >Returns NULL on failure. See <a class="el" href="json__util_8h.html#ad69b0c53974fb6e503260b5b518151b3">json_util_get_last_err()</a> for details. </p>
  199. </div>
  200. </div>
  201. <a id="a588aec4a89d4d4c9c6eb524036d6ecc1" name="a588aec4a89d4d4c9c6eb524036d6ecc1"></a>
  202. <h2 class="memtitle"><span class="permalink"><a href="#a588aec4a89d4d4c9c6eb524036d6ecc1">&#9670;&nbsp;</a></span>json_object_from_file()</h2>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> * json_object_from_file </td>
  208. <td>(</td>
  209. <td class="paramtype">const char *&#160;</td>
  210. <td class="paramname"><em>filename</em></td><td>)</td>
  211. <td></td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p >Read the full contents of the given file, then convert it to a json_object using <a class="el" href="json__tokener_8h.html#a27841b0e4fdcb48b26cfcdb7559c84eb">json_tokener_parse()</a>.</p>
  216. <p >Returns NULL on failure. See <a class="el" href="json__util_8h.html#ad69b0c53974fb6e503260b5b518151b3">json_util_get_last_err()</a> for details. </p>
  217. </div>
  218. </div>
  219. <a id="afd492c120e359d2d75b67da96b580661" name="afd492c120e359d2d75b67da96b580661"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#afd492c120e359d2d75b67da96b580661">&#9670;&nbsp;</a></span>json_object_to_fd()</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int json_object_to_fd </td>
  226. <td>(</td>
  227. <td class="paramtype">int&#160;</td>
  228. <td class="paramname"><em>fd</em>, </td>
  229. </tr>
  230. <tr>
  231. <td class="paramkey"></td>
  232. <td></td>
  233. <td class="paramtype">struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *&#160;</td>
  234. <td class="paramname"><em>obj</em>, </td>
  235. </tr>
  236. <tr>
  237. <td class="paramkey"></td>
  238. <td></td>
  239. <td class="paramtype">int&#160;</td>
  240. <td class="paramname"><em>flags</em>&#160;</td>
  241. </tr>
  242. <tr>
  243. <td></td>
  244. <td>)</td>
  245. <td></td><td></td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p >Convert the json_object to a string and write it to the file descriptor. Handles partial writes and will keep writing until done, or an error occurs.</p>
  250. <dl class="params"><dt>Parameters</dt><dd>
  251. <table class="params">
  252. <tr><td class="paramname">fd</td><td>an open, writable file descriptor to write to </td></tr>
  253. <tr><td class="paramname">obj</td><td>the object to serializer and write </td></tr>
  254. <tr><td class="paramname">flags</td><td>flags to pass to <a class="el" href="json__object_8h.html#a47fe3e7980dc81a1d7f2ab303870789e">json_object_to_json_string_ext()</a> </td></tr>
  255. </table>
  256. </dd>
  257. </dl>
  258. <dl class="section return"><dt>Returns</dt><dd>-1 if something fails. See <a class="el" href="json__util_8h.html#ad69b0c53974fb6e503260b5b518151b3">json_util_get_last_err()</a> for details. </dd></dl>
  259. </div>
  260. </div>
  261. <a id="a486fc95fafe7cb91c58c7f6487036bc5" name="a486fc95fafe7cb91c58c7f6487036bc5"></a>
  262. <h2 class="memtitle"><span class="permalink"><a href="#a486fc95fafe7cb91c58c7f6487036bc5">&#9670;&nbsp;</a></span>json_object_to_file()</h2>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int json_object_to_file </td>
  268. <td>(</td>
  269. <td class="paramtype">const char *&#160;</td>
  270. <td class="paramname"><em>filename</em>, </td>
  271. </tr>
  272. <tr>
  273. <td class="paramkey"></td>
  274. <td></td>
  275. <td class="paramtype">struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *&#160;</td>
  276. <td class="paramname"><em>obj</em>&#160;</td>
  277. </tr>
  278. <tr>
  279. <td></td>
  280. <td>)</td>
  281. <td></td><td></td>
  282. </tr>
  283. </table>
  284. </div><div class="memdoc">
  285. <p >Equivalent to: json_object_to_file_ext(filename, obj, JSON_C_TO_STRING_PLAIN);</p>
  286. <p >Returns -1 if something fails. See <a class="el" href="json__util_8h.html#ad69b0c53974fb6e503260b5b518151b3">json_util_get_last_err()</a> for details. </p>
  287. </div>
  288. </div>
  289. <a id="a68a7385c555cf21797e361d1d4de3441" name="a68a7385c555cf21797e361d1d4de3441"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#a68a7385c555cf21797e361d1d4de3441">&#9670;&nbsp;</a></span>json_object_to_file_ext()</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int json_object_to_file_ext </td>
  296. <td>(</td>
  297. <td class="paramtype">const char *&#160;</td>
  298. <td class="paramname"><em>filename</em>, </td>
  299. </tr>
  300. <tr>
  301. <td class="paramkey"></td>
  302. <td></td>
  303. <td class="paramtype">struct <a class="el" href="json__types_8h.html#af27907ced0f5a43409ad96430fe0f914">json_object</a> *&#160;</td>
  304. <td class="paramname"><em>obj</em>, </td>
  305. </tr>
  306. <tr>
  307. <td class="paramkey"></td>
  308. <td></td>
  309. <td class="paramtype">int&#160;</td>
  310. <td class="paramname"><em>flags</em>&#160;</td>
  311. </tr>
  312. <tr>
  313. <td></td>
  314. <td>)</td>
  315. <td></td><td></td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p >Open and truncate the given file, creating it if necessary, then convert the json_object to a string and write it to the file.</p>
  320. <p >Returns -1 if something fails. See <a class="el" href="json__util_8h.html#ad69b0c53974fb6e503260b5b518151b3">json_util_get_last_err()</a> for details. </p>
  321. </div>
  322. </div>
  323. <a id="a3f0f0b8f29a41b47d62e6c867707be50" name="a3f0f0b8f29a41b47d62e6c867707be50"></a>
  324. <h2 class="memtitle"><span class="permalink"><a href="#a3f0f0b8f29a41b47d62e6c867707be50">&#9670;&nbsp;</a></span>json_parse_double()</h2>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int json_parse_double </td>
  330. <td>(</td>
  331. <td class="paramtype">const char *&#160;</td>
  332. <td class="paramname"><em>buf</em>, </td>
  333. </tr>
  334. <tr>
  335. <td class="paramkey"></td>
  336. <td></td>
  337. <td class="paramtype">double *&#160;</td>
  338. <td class="paramname"><em>retval</em>&#160;</td>
  339. </tr>
  340. <tr>
  341. <td></td>
  342. <td>)</td>
  343. <td></td><td></td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd></dd></dl>
  348. </div>
  349. </div>
  350. <a id="a9d9a63936cdae6639b9cdd87fdd13506" name="a9d9a63936cdae6639b9cdd87fdd13506"></a>
  351. <h2 class="memtitle"><span class="permalink"><a href="#a9d9a63936cdae6639b9cdd87fdd13506">&#9670;&nbsp;</a></span>json_parse_int64()</h2>
  352. <div class="memitem">
  353. <div class="memproto">
  354. <table class="memname">
  355. <tr>
  356. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int json_parse_int64 </td>
  357. <td>(</td>
  358. <td class="paramtype">const char *&#160;</td>
  359. <td class="paramname"><em>buf</em>, </td>
  360. </tr>
  361. <tr>
  362. <td class="paramkey"></td>
  363. <td></td>
  364. <td class="paramtype"><a class="el" href="json__inttypes_8h.html#a67a9885ef4908cb72ce26d75b694386c">int64_t</a> *&#160;</td>
  365. <td class="paramname"><em>retval</em>&#160;</td>
  366. </tr>
  367. <tr>
  368. <td></td>
  369. <td>)</td>
  370. <td></td><td></td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. <p >A parsing helper for integer values. Returns 0 on success, with the parsed value assigned to *retval. Overflow/underflow are NOT considered errors, but errno will be set to ERANGE, just like the strtol/strtoll functions do. </p>
  375. </div>
  376. </div>
  377. <a id="a94c2340c1344d57f7aa067f2dd0407f9" name="a94c2340c1344d57f7aa067f2dd0407f9"></a>
  378. <h2 class="memtitle"><span class="permalink"><a href="#a94c2340c1344d57f7aa067f2dd0407f9">&#9670;&nbsp;</a></span>json_parse_uint64()</h2>
  379. <div class="memitem">
  380. <div class="memproto">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int json_parse_uint64 </td>
  384. <td>(</td>
  385. <td class="paramtype">const char *&#160;</td>
  386. <td class="paramname"><em>buf</em>, </td>
  387. </tr>
  388. <tr>
  389. <td class="paramkey"></td>
  390. <td></td>
  391. <td class="paramtype"><a class="el" href="json__inttypes_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> *&#160;</td>
  392. <td class="paramname"><em>retval</em>&#160;</td>
  393. </tr>
  394. <tr>
  395. <td></td>
  396. <td>)</td>
  397. <td></td><td></td>
  398. </tr>
  399. </table>
  400. </div><div class="memdoc">
  401. <p >A parsing help for integer values, providing one extra bit of magnitude beyond <a class="el" href="json__util_8h.html#a9d9a63936cdae6639b9cdd87fdd13506">json_parse_int64()</a>. </p>
  402. </div>
  403. </div>
  404. <a id="a0ff86f1188508b9ce4e774be6a0b2674" name="a0ff86f1188508b9ce4e774be6a0b2674"></a>
  405. <h2 class="memtitle"><span class="permalink"><a href="#a0ff86f1188508b9ce4e774be6a0b2674">&#9670;&nbsp;</a></span>json_type_to_name()</h2>
  406. <div class="memitem">
  407. <div class="memproto">
  408. <table class="memname">
  409. <tr>
  410. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> const char * json_type_to_name </td>
  411. <td>(</td>
  412. <td class="paramtype">enum <a class="el" href="json__types_8h.html#ac75c61993722a9b8aaa44704072ec06c">json_type</a>&#160;</td>
  413. <td class="paramname"><em>o_type</em></td><td>)</td>
  414. <td></td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p >Return a string describing the type of the object. e.g. "int", or "object", etc... </p>
  419. </div>
  420. </div>
  421. <a id="ad69b0c53974fb6e503260b5b518151b3" name="ad69b0c53974fb6e503260b5b518151b3"></a>
  422. <h2 class="memtitle"><span class="permalink"><a href="#ad69b0c53974fb6e503260b5b518151b3">&#9670;&nbsp;</a></span>json_util_get_last_err()</h2>
  423. <div class="memitem">
  424. <div class="memproto">
  425. <table class="memname">
  426. <tr>
  427. <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> const char * json_util_get_last_err </td>
  428. <td>(</td>
  429. <td class="paramtype">void&#160;</td>
  430. <td class="paramname"></td><td>)</td>
  431. <td></td>
  432. </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p >Return the last error from various json-c functions, including: json_object_to_file{,<em>ext}, <a class="el" href="json__util_8h.html#afd492c120e359d2d75b67da96b580661">json_object_to_fd()</a> or json_object_from</em>{file,fd}, or NULL if there is none. </p>
  436. </div>
  437. </div>
  438. </div><!-- contents -->
  439. <!-- start footer part -->
  440. <hr class="footer"/><address class="footer"><small>
  441. Generated on Sun Sep 15 2024 16:22:28 for json-c by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
  442. </small></address>
  443. </body>
  444. </html>