blob: 5e9917b216b25e2f93eeaf4269a6d692de72ff5f [file] [log] [blame]
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>MqttMsgBase.encodeRemainingLength Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="encodeRemainingLength method" /><meta name="System.Keywords" content="MqttMsgBase.encodeRemainingLength method" /><meta name="Microsoft.Help.F1" content="uPLibrary.Networking.M2Mqtt.Messages.MqttMsgBase.encodeRemainingLength" /><meta name="Microsoft.Help.Id" content="M:uPLibrary.Networking.M2Mqtt.Messages.MqttMsgBase.encodeRemainingLength(System.Int32,System.Byte[],System.Int32)" /><meta name="Description" content="Encode remaining length and insert it into message buffer" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="uPLibrary.Networking.M2Mqtt.Messages" /><meta name="file" content="b908aa25-988c-45df-47b3-ffb5cafbe538" /><meta name="guid" content="b908aa25-988c-45df-47b3-ffb5cafbe538" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">A Sandcastle Documented Class Library<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="4158a883-de72-1ec4-2209-632a86aebd74.htm" title="A Sandcastle Documented Class Library" tocid="roottoc">A Sandcastle Documented Class Library</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="311542f9-0333-9080-9217-f386962efb4a.htm" title="uPLibrary.Networking.M2Mqtt.Messages" tocid="311542f9-0333-9080-9217-f386962efb4a">uPLibrary.Networking.M2Mqtt.Messages</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm" title="MqttMsgBase Class" tocid="c682cddc-7005-0317-ca4e-dbb5d5c257bc">MqttMsgBase Class</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="fcb20aa8-8841-0509-9bc2-c938dda456ac.htm" title="MqttMsgBase Methods" tocid="fcb20aa8-8841-0509-9bc2-c938dda456ac">MqttMsgBase Methods</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="9bf22223-b9c3-8d18-fbe2-d6fbadcbce91.htm" title="decodeRemainingLength Method " tocid="9bf22223-b9c3-8d18-fbe2-d6fbadcbce91">decodeRemainingLength Method </a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="b908aa25-988c-45df-47b3-ffb5cafbe538.htm" title="encodeRemainingLength Method " tocid="b908aa25-988c-45df-47b3-ffb5cafbe538">encodeRemainingLength Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="f0fafcf1-e39b-e48e-d718-9ce6bbc3e18a.htm" title="GetBytes Method " tocid="f0fafcf1-e39b-e48e-d718-9ce6bbc3e18a">GetBytes Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="317d3669-35cd-c421-71db-8bfc050b144f.htm" title="GetTraceString Method " tocid="317d3669-35cd-c421-71db-8bfc050b144f">GetTraceString Method </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn">MqttMsgBase<span id="LST6FF1E95C_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6FF1E95C_0?cpp=::|nu=.");</script>encodeRemainingLength Method </td></tr></table><span class="introStyle"></span><div class="summary">
Encode remaining length and insert it into message buffer
</div><p> </p><strong>Namespace:</strong> <a href="311542f9-0333-9080-9217-f386962efb4a.htm">uPLibrary.Networking.M2Mqtt.Messages</a><br /><strong>Assembly:</strong> M2Mqtt.Net (in M2Mqtt.Net.dll) Version: 4.3.0.0 (4.3.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cs','1','4');return false;">C#</a></div><div id="ID0EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','vb','2','4');return false;">VB</a></div><div id="ID0EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cpp','3','4');return false;">C++</a></div><div id="ID0EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID0EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">protected</span> <span class="identifier">int</span> <span class="identifier">encodeRemainingLength</span>(
<span class="identifier">int</span> <span class="parameter">remainingLength</span>,
<span class="identifier">byte</span>[] <span class="parameter">buffer</span>,
<span class="identifier">int</span> <span class="parameter">index</span>
)</pre></div><div id="ID0EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Protected</span> <span class="keyword">Function</span> <span class="identifier">encodeRemainingLength</span> (
<span class="parameter">remainingLength</span> <span class="keyword">As</span> <span class="identifier">Integer</span>,
<span class="parameter">buffer</span> <span class="keyword">As</span> <span class="identifier">Byte</span>(),
<span class="parameter">index</span> <span class="keyword">As</span> <span class="identifier">Integer</span>
) <span class="keyword">As</span> <span class="identifier">Integer</span></pre></div><div id="ID0EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">protected</span>:
<span class="identifier">int</span> <span class="identifier">encodeRemainingLength</span>(
<span class="identifier">int</span> <span class="parameter">remainingLength</span>,
<span class="keyword">array</span>&lt;<span class="identifier">unsigned char</span>&gt;^ <span class="parameter">buffer</span>,
<span class="identifier">int</span> <span class="parameter">index</span>
)</pre></div><div id="ID0EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">member</span> <span class="identifier">encodeRemainingLength</span> :
<span class="parameter">remainingLength</span> : <span class="identifier">int</span> *
<span class="parameter">buffer</span> : <span class="identifier">byte</span>[] *
<span class="parameter">index</span> : <span class="identifier">int</span> <span class="keyword">-&gt;</span> <span class="identifier">int</span>
</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">remainingLength</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/td2s409d" target="_blank">System<span id="LST6FF1E95C_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6FF1E95C_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Int32</a><br />Remaining length value to encode</dd><dt><span class="parameter">buffer</span></dt><dd>Type: <span id="LST6FF1E95C_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6FF1E95C_2?cpp=array&lt;");</script><a href="http://msdn2.microsoft.com/en-us/library/yyb1w04y" target="_blank">System<span id="LST6FF1E95C_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6FF1E95C_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Byte</a><span id="LST6FF1E95C_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6FF1E95C_4?cpp=&gt;|vb=()|nu=[]");</script><br />Message buffer for inserting encoded value</dd><dt><span class="parameter">index</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/td2s409d" target="_blank">System<span id="LST6FF1E95C_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6FF1E95C_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Int32</a><br />Index from which insert encoded value into buffer</dd></dl><h4 class="subHeading">Return Value</h4>Type: <a href="http://msdn2.microsoft.com/en-us/library/td2s409d" target="_blank">Int32</a><br />Index updated</div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase Class</a></div><div class="seeAlsoStyle"><a href="311542f9-0333-9080-9217-f386962efb4a.htm">uPLibrary.Networking.M2Mqtt.Messages Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>