lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-04-24 23:37:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Publish!

Browse Source 
Generated from v6.0.11315.11111-test13
This commit is contained in:
Bozo
2018-02-02 07:57:49 -08:00
parent db96b72945
commit 9af473956f
957 changed files with 32952 additions and 16598 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
6/d8/d05/class_o_n___base64_encode_stream.html
View File

@@ -59,32 +59,34 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a59bafbe876fc28de35c09671a8682681"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a59bafbe876fc28de35c09671a8682681">~ON_Base64EncodeStream</a> ()</td></tr>
<tr class="separator:a59bafbe876fc28de35c09671a8682681"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71f87adfad42a196b9935f5c28790452"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a71f87adfad42a196b9935f5c28790452">Begin</a> ()</td></tr>
<tr class="memdesc:a71f87adfad42a196b9935f5c28790452"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a71f87adfad42a196b9935f5c28790452" title="Call Begin() one time to initialize the base64 encoding calculation. Then call In() one or more times...">Begin()</a> one time to initialize the base64 encoding calculation. Then call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a> one or more times to submit the unencoded stream to the base64 encoding calculation. When you reach the end of the unencoded stream, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a>. <a href="#a71f87adfad42a196b9935f5c28790452">More...</a><br /></td></tr>
<tr class="separator:a71f87adfad42a196b9935f5c28790452"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a776f066c9db60eb5b19db93164052b95"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a776f066c9db60eb5b19db93164052b95">CallbackContext</a> () const</td></tr>
<tr class="separator:a776f066c9db60eb5b19db93164052b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6ba99f8d2f17d5919cc1587da181b08"><td class="memItemLeft" align="right" valign="top">ON_StreamCallbackFunction&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af6ba99f8d2f17d5919cc1587da181b08">CallbackFunction</a> () const</td></tr>
<tr class="separator:af6ba99f8d2f17d5919cc1587da181b08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a402c30a5d269cc02b2376dc4d93c3d0c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End</a> ()</td></tr>
<tr class="memdesc:a402c30a5d269cc02b2376dc4d93c3d0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">After the last call to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a>, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a>. Calling <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a> may generate one call to the output stream handler with the value of out_buffer_size = 4 to 76. <a href="#a402c30a5d269cc02b2376dc4d93c3d0c">More...</a><br /></td></tr>
<tr class="separator:a402c30a5d269cc02b2376dc4d93c3d0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad596f2868c0d3d7723fefde8bdf057fc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc">In</a> (ON__UINT64 in_buffer_size, const void *in_buffer)</td></tr>
<tr class="memdesc:ad596f2868c0d3d7723fefde8bdf057fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a> one or more times to base64 encode a stream of bytes. After the last call to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a>, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a>. Calling <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a> will result in at least in_buffer_size/57 and at most (in_buffer_size+56)/57 calls to to the output stream handler. <a href="#ad596f2868c0d3d7723fefde8bdf057fc">More...</a><br /></td></tr>
<tr class="separator:ad596f2868c0d3d7723fefde8bdf057fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a243e2a5ebdc365bbd29c74f76b5ac160"><td class="memItemLeft" align="right" valign="top">ON__UINT32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a243e2a5ebdc365bbd29c74f76b5ac160">InCRC</a> () const</td></tr>
<tr class="separator:a243e2a5ebdc365bbd29c74f76b5ac160"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e64a1a1be3ee2d5a83af26a21d56460"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a8e64a1a1be3ee2d5a83af26a21d56460">InSize</a> () const</td></tr>
<tr class="separator:a8e64a1a1be3ee2d5a83af26a21d56460"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af17f96269d231fef871ea7c987fa396f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out</a> (void *callback_context, ON__UINT32 out_buffer_size, const char *out_buffer)</td></tr>
<tr class="memdesc:af17f96269d231fef871ea7c987fa396f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If an explicit base 64 encoded stream output handler is not specified ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af6ba99f8d2f17d5919cc1587da181b08">CallbackFunction()</a> returns null ), then the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> function is called to handle the base 64 encoded output stream. As the input stream is encoded, one or more calls to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> will occur. <a href="#af17f96269d231fef871ea7c987fa396f">More...</a><br /></td></tr>
<tr class="separator:af17f96269d231fef871ea7c987fa396f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75dd64a0e00dad3bc66ecce67fba56ba"><td class="memItemLeft" align="right" valign="top">ON__UINT32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a75dd64a0e00dad3bc66ecce67fba56ba">OutCRC</a> () const</td></tr>
<tr class="separator:a75dd64a0e00dad3bc66ecce67fba56ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73eac165b54442dc4f7a951e9baaeb3a"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a73eac165b54442dc4f7a951e9baaeb3a">OutSize</a> () const</td></tr>
<tr class="separator:a73eac165b54442dc4f7a951e9baaeb3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11316609e98cd845a2047bfdbeadff7d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a11316609e98cd845a2047bfdbeadff7d">SetCallback</a> (ON_StreamCallbackFunction callback_function, void *callback_context)</td></tr>
<tr class="memdesc:a11316609e98cd845a2047bfdbeadff7d"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html">ON_Base64EncodeStream</a> delivers the base64 encoded stream by calling a base64 encoded stream output handler function. There are two options for specifying the base64 encoded stream output handler function. <a href="#a11316609e98cd845a2047bfdbeadff7d">More...</a><br /></td></tr>
<tr class="separator:a11316609e98cd845a2047bfdbeadff7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section rcs"><dt>NoKeywords</dt><dd></dd></dl>
<p>/ / Copyright (c) 1993-2012 Robert McNeel &amp; Associates. All rights reserved. / OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert / McNeel &amp; Associates. / / THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY. / ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF / MERCHANTABILITY ARE HEREBY DISCLAIMED. / / For complete openNURBS copyright information see <a href="http://www.opennurbs.org">http://www.opennurbs.org</a>. / ////////////////////////////////////////////////////////////// </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3cfc6ce021d5f661e7ce3e374376669c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cfc6ce021d5f661e7ce3e374376669c">&#9670;&nbsp;</a></span>ON_Base64EncodeStream()</h2>
@@ -142,7 +144,9 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a71f87adfad42a196b9935f5c28790452">Begin()</a> one time to initialize the base64 encoding calculation. Then call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc">In()</a> one or more times to submit the unencoded stream to the base64 encoding calculation. When you reach the end of the unencoded stream, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End()</a>. Returns: true if successful, false if an error occured. </p>
<p>Call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a71f87adfad42a196b9935f5c28790452" title="Call Begin() one time to initialize the base64 encoding calculation. Then call In() one or more times...">Begin()</a> one time to initialize the base64 encoding calculation. Then call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a> one or more times to submit the unencoded stream to the base64 encoding calculation. When you reach the end of the unencoded stream, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false if an error occured. </dd></dl>
</div>
</div>
@@ -160,7 +164,7 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Current value of the context pointer passed as the first argument to the base64 encoded stream output handler function. </p>
<dl class="section return"><dt>Returns</dt><dd>Current value of the context pointer passed as the first argument to the base64 encoded stream output handler function. </dd></dl>
</div>
</div>
@@ -178,7 +182,7 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Current value of the callback function for handling the base64 encoded stream. If the callback function is null, the the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out()</a> function is used to handle the output stream. </p>
<dl class="section return"><dt>Returns</dt><dd>Current value of the callback function for handling the base64 encoded stream. If the callback function is null, the the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> function is used to handle the output stream. </dd></dl>
</div>
</div>
@@ -196,7 +200,9 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: After the last call to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc">In()</a>, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End()</a>. Calling <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End()</a> may generate one call to the output stream handler with the value of out_buffer_size = 4 to 76. Returns: true if successful, false if an error occured. </p>
<p>After the last call to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a>, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a>. Calling <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a> may generate one call to the output stream handler with the value of out_buffer_size = 4 to 76. </p>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false if an error occured. </dd></dl>
</div>
</div>
@@ -225,7 +231,16 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc">In()</a> one or more times to base64 encode a stream of bytes. After the last call to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc">In()</a>, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End()</a>. Calling <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc">In()</a> will result in at least in_buffer_size/57 and at most (in_buffer_size+56)/57 calls to to the output stream handler. Parameters: in_buffer_size - [in] number of bytes in in_buffer in_buffer - [in] Returns: true if successful, false if an error occured. </p>
<p>Call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a> one or more times to base64 encode a stream of bytes. After the last call to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a>, call <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a>. Calling <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a> will result in at least in_buffer_size/57 and at most (in_buffer_size+56)/57 calls to to the output stream handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in_buffer_size</td><td>[in] number of bytes in in_buffer</td></tr>
<tr><td class="paramname">in_buffer</td><td>[in]</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false if an error occured. </dd></dl>
</div>
</div>
@@ -243,7 +258,7 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Then the returned value is the 32-bit crc of the input stream. The crc is updated every time <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc">In()</a> is called before any calls are made to the output stream handler. If the base64 encoding calculation is finished ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End()</a> has been called ), then the returned value is the 32-bit crc of the entire input stream. </p>
<dl class="section return"><dt>Returns</dt><dd>Then the returned value is the 32-bit crc of the input stream. The crc is updated every time <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a> is called before any calls are made to the output stream handler. If the base64 encoding calculation is finished ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a> has been called ), then the returned value is the 32-bit crc of the entire input stream. </dd></dl>
</div>
</div>
@@ -261,7 +276,7 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Then the returned value is the total number bytes in the input stream. The size is updated every time <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc">In()</a> is called before any calls are made to the output stream handler. If the calculation is finished ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End()</a> has been called ), then the returned value is the total number of bytes in the entire input stream. </p>
<dl class="section return"><dt>Returns</dt><dd>Then the returned value is the total number bytes in the input stream. The size is updated every time <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#ad596f2868c0d3d7723fefde8bdf057fc" title="Call In() one or more times to base64 encode a stream of bytes. After the last call to In()...">In()</a> is called before any calls are made to the output stream handler. If the calculation is finished ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a> has been called ), then the returned value is the total number of bytes in the entire input stream. </dd></dl>
</div>
</div>
@@ -304,8 +319,18 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: If an explicit base 64 encoded stream output handler is not specified ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af6ba99f8d2f17d5919cc1587da181b08">CallbackFunction()</a> returns null ), then the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out()</a> function is called to handle the base 64 encoded output stream. As the input stream is encoded, one or more calls to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out()</a> will occur.</p>
<p>With a possible exception of the last call to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out()</a>, when <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out()</a> is called, 57 input bytes have been encoded into 76 output characters with ASCII codes A-Z, a-z, 0-9, +, /. Parameters: callback_context - [in] context pointer set by calling <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a11316609e98cd845a2047bfdbeadff7d">SetCallback()</a>. Typically the context pointer is not used by a virtual override because the context can be added as member variables of the derived class, but it is available if needed. out_buffer_size - [in] number of non-null characters in out_buffer. out_buffer - [in] A null terminated ASCII string that is a base 64 encoding. out_buffer[0...(out_buffer_size-1)] are ASCII characters with values characters with ASCII codes A-Z, a-z, 0-9, +, / and out_buffer[out_buffer_size] = 0. Returns: True to continue base 64 encodeing and false to cancel the encoding calculation. </p>
<p>If an explicit base 64 encoded stream output handler is not specified ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af6ba99f8d2f17d5919cc1587da181b08">CallbackFunction()</a> returns null ), then the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> function is called to handle the base 64 encoded output stream. As the input stream is encoded, one or more calls to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> will occur. </p>
<p>With a possible exception of the last call to <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a>, when <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> is called, 57 input bytes have been encoded into 76 output characters with ASCII codes A-Z, a-z, 0-9, +, /. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback_context</td><td>[in] context pointer set by calling <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a11316609e98cd845a2047bfdbeadff7d" title="ON_Base64EncodeStream delivers the base64 encoded stream by calling a base64 encoded stream output ha...">SetCallback()</a>. Typically the context pointer is not used by a virtual override because the context can be added as member variables of the derived class, but it is available if needed.</td></tr>
<tr><td class="paramname">out_buffer_size</td><td>[in] number of non-null characters in out_buffer.</td></tr>
<tr><td class="paramname">out_buffer</td><td>[in] A null terminated ASCII string that is a base 64 encoding. out_buffer[0...(out_buffer_size-1)] are ASCII characters with values characters with ASCII codes A-Z, a-z, 0-9, +, / and out_buffer[out_buffer_size] = 0.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True to continue base 64 encodeing and false to cancel the encoding calculation. </dd></dl>
</div>
</div>
@@ -323,7 +348,7 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Then the returned value is the 32bit crc of the output stream. The crc is updated immediately after each call to the output stream handler. If the calculation is finished ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End()</a> has been called ), then the returned value is the 32-bit crc of the entire output stream. </p>
<dl class="section return"><dt>Returns</dt><dd>Then the returned value is the 32bit crc of the output stream. The crc is updated immediately after each call to the output stream handler. If the calculation is finished ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a> has been called ), then the returned value is the 32-bit crc of the entire output stream. </dd></dl>
</div>
</div>
@@ -341,7 +366,7 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Then the returned value is the total number characters in the output stream. The size is incremented immediately after each call to the output stream handler. If the base64 encoding calculation is finished ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c">End()</a> has been called ), then the returned value is the total number of bytes in the entire output stream. </p>
<dl class="section return"><dt>Returns</dt><dd>Then the returned value is the total number characters in the output stream. The size is incremented immediately after each call to the output stream handler. If the base64 encoding calculation is finished ( <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a402c30a5d269cc02b2376dc4d93c3d0c" title="After the last call to In(), call End(). Calling End() may generate one call to the output stream han...">End()</a> has been called ), then the returned value is the total number of bytes in the entire output stream. </dd></dl>
</div>
</div>
@@ -370,10 +395,21 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html">ON_Base64EncodeStream</a> delivers the base64 encoded stream by calling a base64 encoded stream output handler function. There are two options for specifying the base64 encoded stream output handler function.</p><ol type="1">
<li>Overriding the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out()</a> function.</li>
<li>Providing a callback function. <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a11316609e98cd845a2047bfdbeadff7d">SetCallback()</a> is used to specify a callback function to handle the base64 encoded stream and to specify a context pointer to be passed to either option of the handler. Parameters: callback_function - [in] Function to handle sections of the base64 encoded stream. If callback_function is null, then the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out()</a> function will be called. When callback_function is specified, it must return true if the base64 encoding calculation should continue and false to cancel the base64 encoding calculation. callback_context - [in] This value is passed as the first argument when calling callback_function or the virutal <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f">Out()</a> function. Returns: True if successful. Remarks: Once base64 encoding has started, it would be unusual to intentionally change the base64 encoded stream output handler, but you can do this if you need to. </li>
<p><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html">ON_Base64EncodeStream</a> delivers the base64 encoded stream by calling a base64 encoded stream output handler function. There are two options for specifying the base64 encoded stream output handler function. </p>
<ol type="1">
<li>Overriding the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> function.</li>
<li>Providing a callback function. <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a11316609e98cd845a2047bfdbeadff7d" title="ON_Base64EncodeStream delivers the base64 encoded stream by calling a base64 encoded stream output ha...">SetCallback()</a> is used to specify a callback function to handle the base64 encoded stream and to specify a context pointer to be passed to either option of the handler. </li>
</ol>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback_function</td><td>[in] Function to handle sections of the base64 encoded stream. If callback_function is null, then the virtual <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> function will be called. When callback_function is specified, it must return true if the base64 encoding calculation should continue and false to cancel the base64 encoding calculation.</td></tr>
<tr><td class="paramname">callback_context</td><td>[in] This value is passed as the first argument when calling callback_function or the virutal <a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#af17f96269d231fef871ea7c987fa396f" title="If an explicit base 64 encoded stream output handler is not specified ( CallbackFunction() returns nu...">Out()</a> function.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
<p>Once base64 encoding has started, it would be unusual to intentionally change the base64 encoded stream output handler, but you can do this if you need to. </p>
</div>
</div>
@@ -383,7 +419,7 @@ Public Member Functions</h2></td></tr>
</div> <!-- page-content -->
</div> <!-- container -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 31 2018 14:45:38 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
Generated on Fri Feb 2 2018 07:57:28 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
Doxygen
</a> 1.8.13