lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-03-30 23:57:58 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
2ea16cc86c1bf38a04f2a8015c790e9304c053ce
opennurbs/6/d8/d05/class_o_n___base64_encode_stream.html
Bozo 2ea16cc86c Publish! 
Generated from TESTING
2018-01-26 12:40:11 +00:00

411 lines
25 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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: ON_Base64EncodeStream Class Reference</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">openNURBS SDK Help
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d2/d71/class_o_n___base64_encode_stream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_Base64EncodeStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d3/dce/opennurbs__base64_8h_source.html">opennurbs_base64.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3cfc6ce021d5f661e7ce3e374376669c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d05/class_o_n___base64_encode_stream.html#a3cfc6ce021d5f661e7ce3e374376669c">ON_Base64EncodeStream</a> ()</td></tr>
<tr class="separator:a3cfc6ce021d5f661e7ce3e374376669c"><td class="memSeparator" colspan="2">&#160;</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="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="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="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="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="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><br />
/ / 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. / <br />
/ 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>
<a id="a3cfc6ce021d5f661e7ce3e374376669c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cfc6ce021d5f661e7ce3e374376669c">&#9670;&nbsp;</a></span>ON_Base64EncodeStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_Base64EncodeStream::ON_Base64EncodeStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a59bafbe876fc28de35c09671a8682681"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59bafbe876fc28de35c09671a8682681">&#9670;&nbsp;</a></span>~ON_Base64EncodeStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ON_Base64EncodeStream::~ON_Base64EncodeStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a71f87adfad42a196b9935f5c28790452"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71f87adfad42a196b9935f5c28790452">&#9670;&nbsp;</a></span>Begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Base64EncodeStream::Begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</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>
</div>
</div>
<a id="a776f066c9db60eb5b19db93164052b95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a776f066c9db60eb5b19db93164052b95">&#9670;&nbsp;</a></span>CallbackContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ON_Base64EncodeStream::CallbackContext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</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>
</div>
</div>
<a id="af6ba99f8d2f17d5919cc1587da181b08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6ba99f8d2f17d5919cc1587da181b08">&#9670;&nbsp;</a></span>CallbackFunction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_StreamCallbackFunction ON_Base64EncodeStream::CallbackFunction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</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>
</div>
</div>
<a id="a402c30a5d269cc02b2376dc4d93c3d0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a402c30a5d269cc02b2376dc4d93c3d0c">&#9670;&nbsp;</a></span>End()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Base64EncodeStream::End </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</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>
</div>
</div>
<a id="ad596f2868c0d3d7723fefde8bdf057fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad596f2868c0d3d7723fefde8bdf057fc">&#9670;&nbsp;</a></span>In()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Base64EncodeStream::In </td>
<td>(</td>
<td class="paramtype">ON__UINT64&#160;</td>
<td class="paramname"><em>in_buffer_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>in_buffer</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</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>
</div>
</div>
<a id="a243e2a5ebdc365bbd29c74f76b5ac160"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a243e2a5ebdc365bbd29c74f76b5ac160">&#9670;&nbsp;</a></span>InCRC()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT32 ON_Base64EncodeStream::InCRC </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</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>
</div>
</div>
<a id="a8e64a1a1be3ee2d5a83af26a21d56460"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e64a1a1be3ee2d5a83af26a21d56460">&#9670;&nbsp;</a></span>InSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT64 ON_Base64EncodeStream::InSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</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>
</div>
</div>
<a id="af17f96269d231fef871ea7c987fa396f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af17f96269d231fef871ea7c987fa396f">&#9670;&nbsp;</a></span>Out()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ON_Base64EncodeStream::Out </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>callback_context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT32&#160;</td>
<td class="paramname"><em>out_buffer_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>out_buffer</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</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. <br />
Returns: True to continue base 64 encodeing and false to cancel the encoding calculation. </p>
</div>
</div>
<a id="a75dd64a0e00dad3bc66ecce67fba56ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75dd64a0e00dad3bc66ecce67fba56ba">&#9670;&nbsp;</a></span>OutCRC()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT32 ON_Base64EncodeStream::OutCRC </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</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>
</div>
</div>
<a id="a73eac165b54442dc4f7a951e9baaeb3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73eac165b54442dc4f7a951e9baaeb3a">&#9670;&nbsp;</a></span>OutSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT64 ON_Base64EncodeStream::OutSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</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>
</div>
</div>
<a id="a11316609e98cd845a2047bfdbeadff7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11316609e98cd845a2047bfdbeadff7d">&#9670;&nbsp;</a></span>SetCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Base64EncodeStream::SetCallback </td>
<td>(</td>
<td class="paramtype">ON_StreamCallbackFunction&#160;</td>
<td class="paramname"><em>callback_function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>callback_context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</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>
</ol>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 26 2018 12:38:20 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink