struct_m_q_t_t_properties.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  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=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Paho MQTT C Client Library: MQTTProperties Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="pahologo.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">Paho MQTT C Client Library
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#pub-attribs">Data Fields</a> </div>
  65. <div class="headertitle">
  66. <div class="title">MQTTProperties Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p><code>#include &lt;<a class="el" href="_m_q_t_t_properties_8h_source.html">MQTTProperties.h</a>&gt;</code></p>
  70. <table class="memberdecls">
  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  72. Data Fields</h2></td></tr>
  73. <tr class="memitem:ad43c3812e6d13e0518d9f8b8f463ffcf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_properties.html#ad43c3812e6d13e0518d9f8b8f463ffcf">count</a></td></tr>
  74. <tr class="separator:ad43c3812e6d13e0518d9f8b8f463ffcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a8de324382d8fd2f5939bf3372e059383"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_properties.html#a8de324382d8fd2f5939bf3372e059383">max_count</a></td></tr>
  76. <tr class="separator:a8de324382d8fd2f5939bf3372e059383"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a9f59b34b1f25fe00023291b678246bcc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_properties.html#a9f59b34b1f25fe00023291b678246bcc">length</a></td></tr>
  78. <tr class="separator:a9f59b34b1f25fe00023291b678246bcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a3ac4c38b423393c1553dcf8b71e7dd58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_m_q_t_t_property.html">MQTTProperty</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_properties.html#a3ac4c38b423393c1553dcf8b71e7dd58">array</a></td></tr>
  80. <tr class="separator:a3ac4c38b423393c1553dcf8b71e7dd58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. </table>
  82. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  83. <div class="textblock"><p>MQTT version 5 property list </p>
  84. </div><h2 class="groupheader">Field Documentation</h2>
  85. <a id="ad43c3812e6d13e0518d9f8b8f463ffcf"></a>
  86. <h2 class="memtitle"><span class="permalink"><a href="#ad43c3812e6d13e0518d9f8b8f463ffcf">&#9670;&nbsp;</a></span>count</h2>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname">int count</td>
  92. </tr>
  93. </table>
  94. </div><div class="memdoc">
  95. <p>number of property entries in the array </p>
  96. </div>
  97. </div>
  98. <a id="a8de324382d8fd2f5939bf3372e059383"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#a8de324382d8fd2f5939bf3372e059383">&#9670;&nbsp;</a></span>max_count</h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">int max_count</td>
  105. </tr>
  106. </table>
  107. </div><div class="memdoc">
  108. <p>max number of properties that the currently allocated array can store </p>
  109. </div>
  110. </div>
  111. <a id="a9f59b34b1f25fe00023291b678246bcc"></a>
  112. <h2 class="memtitle"><span class="permalink"><a href="#a9f59b34b1f25fe00023291b678246bcc">&#9670;&nbsp;</a></span>length</h2>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">int length</td>
  118. </tr>
  119. </table>
  120. </div><div class="memdoc">
  121. <p>mbi: byte length of all properties </p>
  122. </div>
  123. </div>
  124. <a id="a3ac4c38b423393c1553dcf8b71e7dd58"></a>
  125. <h2 class="memtitle"><span class="permalink"><a href="#a3ac4c38b423393c1553dcf8b71e7dd58">&#9670;&nbsp;</a></span>array</h2>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname"><a class="el" href="struct_m_q_t_t_property.html">MQTTProperty</a>* array</td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. <p>array of properties </p>
  135. </div>
  136. </div>
  137. <hr/>The documentation for this struct was generated from the following file:<ul>
  138. <li><a class="el" href="_m_q_t_t_properties_8h_source.html">MQTTProperties.h</a></li>
  139. </ul>
  140. </div><!-- contents -->
  141. <!-- start footer part -->
  142. <hr class="footer"/><address class="footer"><small>
  143. Generated on Thu Sep 29 2022 11:34:45 for Paho MQTT C Client Library by &#160;<a href="http://www.doxygen.org/index.html">
  144. <img class="footer" src="doxygen.png" alt="doxygen"/>
  145. </a> 1.8.17
  146. </small></address>
  147. </body>
  148. </html>