mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-04-01 17:08:57 +08:00
447 lines
34 KiB
HTML
447 lines
34 KiB
HTML
<!-- HTML header for doxygen 1.8.13-->
|
|
<!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.13"/>
|
|
<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="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<!-- bootstrap -->
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
|
|
<!-- smartmenus -->
|
|
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
|
|
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
|
|
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
|
|
</head>
|
|
<body>
|
|
<!-- <div class="version-banner">
|
|
Go back to the <a href="/">main site</a>...
|
|
</div> -->
|
|
<div class="container">
|
|
<!-- navbar -->
|
|
<nav class="navbar navbar-default">
|
|
<div class="container-fluid">
|
|
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
|
|
<div class="navbar-collapse collapse" id="main-nav-placeholder">
|
|
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">Latest (6.x)</a></li>
|
|
<li class="disabled"><a href="#">WIP (7.x)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="page-content">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<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 <<a class="el" href="../../d3/dce/opennurbs__base64_8h_source.html">opennurbs_base64.h</a>></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"> </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"> </td></tr>
|
|
<tr class="memitem:a59bafbe876fc28de35c09671a8682681"><td class="memItemLeft" align="right" valign="top">virtual </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"> </td></tr>
|
|
<tr class="memitem:a71f87adfad42a196b9935f5c28790452"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:a776f066c9db60eb5b19db93164052b95"><td class="memItemLeft" align="right" valign="top">void * </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"> </td></tr>
|
|
<tr class="memitem:af6ba99f8d2f17d5919cc1587da181b08"><td class="memItemLeft" align="right" valign="top">ON_StreamCallbackFunction </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"> </td></tr>
|
|
<tr class="memitem:a402c30a5d269cc02b2376dc4d93c3d0c"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:ad596f2868c0d3d7723fefde8bdf057fc"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:a243e2a5ebdc365bbd29c74f76b5ac160"><td class="memItemLeft" align="right" valign="top">ON__UINT32 </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"> </td></tr>
|
|
<tr class="memitem:a8e64a1a1be3ee2d5a83af26a21d56460"><td class="memItemLeft" align="right" valign="top">ON__UINT64 </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"> </td></tr>
|
|
<tr class="memitem:af17f96269d231fef871ea7c987fa396f"><td class="memItemLeft" align="right" valign="top">virtual bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:a75dd64a0e00dad3bc66ecce67fba56ba"><td class="memItemLeft" align="right" valign="top">ON__UINT32 </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"> </td></tr>
|
|
<tr class="memitem:a73eac165b54442dc4f7a951e9baaeb3a"><td class="memItemLeft" align="right" valign="top">ON__UINT64 </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"> </td></tr>
|
|
<tr class="memitem:a11316609e98cd845a2047bfdbeadff7d"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a3cfc6ce021d5f661e7ce3e374376669c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3cfc6ce021d5f661e7ce3e374376669c">◆ </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">◆ </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">◆ </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>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>
|
|
<a id="a776f066c9db60eb5b19db93164052b95"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a776f066c9db60eb5b19db93164052b95">◆ </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">
|
|
<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>
|
|
<a id="af6ba99f8d2f17d5919cc1587da181b08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6ba99f8d2f17d5919cc1587da181b08">◆ </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">
|
|
<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>
|
|
<a id="a402c30a5d269cc02b2376dc4d93c3d0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a402c30a5d269cc02b2376dc4d93c3d0c">◆ </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>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>
|
|
<a id="ad596f2868c0d3d7723fefde8bdf057fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad596f2868c0d3d7723fefde8bdf057fc">◆ </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 </td>
|
|
<td class="paramname"><em>in_buffer_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>in_buffer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<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>
|
|
<a id="a243e2a5ebdc365bbd29c74f76b5ac160"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a243e2a5ebdc365bbd29c74f76b5ac160">◆ </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">
|
|
<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>
|
|
<a id="a8e64a1a1be3ee2d5a83af26a21d56460"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e64a1a1be3ee2d5a83af26a21d56460">◆ </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">
|
|
<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>
|
|
<a id="af17f96269d231fef871ea7c987fa396f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af17f96269d231fef871ea7c987fa396f">◆ </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 * </td>
|
|
<td class="paramname"><em>callback_context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ON__UINT32 </td>
|
|
<td class="paramname"><em>out_buffer_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>out_buffer</em> </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>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>
|
|
<a id="a75dd64a0e00dad3bc66ecce67fba56ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a75dd64a0e00dad3bc66ecce67fba56ba">◆ </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">
|
|
<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>
|
|
<a id="a73eac165b54442dc4f7a951e9baaeb3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73eac165b54442dc4f7a951e9baaeb3a">◆ </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">
|
|
<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>
|
|
<a id="a11316609e98cd845a2047bfdbeadff7d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11316609e98cd845a2047bfdbeadff7d">◆ </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 </td>
|
|
<td class="paramname"><em>callback_function</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>callback_context</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<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>
|
|
</div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
</div> <!-- page-content -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Feb 3 2018 11:08:29 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
|
|
</small></address>
|
|
</div> <!-- container -->
|
|
<!-- doxy-boot -->
|
|
<script type="text/javascript" src="../../doxy-boot.js"></script>
|
|
</body>
|
|
</html>
|