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
05ca20eaf4faacef2aba407d3d0ce037e9ed1e16
opennurbs/6/df/d05/class_o_n___buffer.html
Bozo 832ccb5c1a Publish! 
Generated from v6.0.11315.11111-test14
2018-02-03 11:08:49 -08:00

821 lines
49 KiB
HTML
Raw Blame History

<!-- 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_Buffer 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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="../../d5/d53/class_o_n___buffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_Buffer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d3/dad/opennurbs__archive_8h_source.html">opennurbs_archive.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a52f93f0eb0f5e0e1dd18fc21c60daf6e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="../../df/d05/class_o_n___buffer.html#a52f93f0eb0f5e0e1dd18fc21c60daf6ea352b035d364af17d28160dc99afd5198">seek_from_beginning_of_file</a> = 0,
<a class="el" href="../../df/d05/class_o_n___buffer.html#a52f93f0eb0f5e0e1dd18fc21c60daf6eab6ccec3d4f760ef1d489adb65b9d9529">seek_from_current_position</a> = 1,
<a class="el" href="../../df/d05/class_o_n___buffer.html#a52f93f0eb0f5e0e1dd18fc21c60daf6ea7e9c8bb05c0e70b98af45f70ca29138c">seek_from_end_of_file</a> = 2
}</td></tr>
<tr class="separator:a52f93f0eb0f5e0e1dd18fc21c60daf6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a73055465dda25f22d75ad5587a5bdabd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a73055465dda25f22d75ad5587a5bdabd">ON_Buffer</a> ()</td></tr>
<tr class="separator:a73055465dda25f22d75ad5587a5bdabd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04b4b2453dc5ac21eed0fcdd93b44772"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a04b4b2453dc5ac21eed0fcdd93b44772">ON_Buffer</a> (const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;src)</td></tr>
<tr class="separator:a04b4b2453dc5ac21eed0fcdd93b44772"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7681288987d91c8a4816b6dc8c64cc2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#aa7681288987d91c8a4816b6dc8c64cc2">~ON_Buffer</a> ()</td></tr>
<tr class="separator:aa7681288987d91c8a4816b6dc8c64cc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a399e0b3b25725f8b64e3d0113102fe4f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a399e0b3b25725f8b64e3d0113102fe4f">AtEnd</a> () const</td></tr>
<tr class="separator:a399e0b3b25725f8b64e3d0113102fe4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac771b73243d8a308765a5d2e53f6a041"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ac771b73243d8a308765a5d2e53f6a041">ChangeSize</a> (ON__UINT64 buffer_size)</td></tr>
<tr class="separator:ac771b73243d8a308765a5d2e53f6a041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a774b8d06f510e12889725affe1e750bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a774b8d06f510e12889725affe1e750bc">ClearLastError</a> ()</td></tr>
<tr class="separator:a774b8d06f510e12889725affe1e750bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab419542485bc354732e11b6134c1de2b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ab419542485bc354732e11b6134c1de2b">Compact</a> ()</td></tr>
<tr class="memdesc:ab419542485bc354732e11b6134c1de2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return unused memory to heap. <a href="#ab419542485bc354732e11b6134c1de2b">More...</a><br /></td></tr>
<tr class="separator:ab419542485bc354732e11b6134c1de2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a962c3308c3d85963642c0ca1242d0ac7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7">Compress</a> (<a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;compressed_buffer) const</td></tr>
<tr class="memdesc:a962c3308c3d85963642c0ca1242d0ac7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compress this buffer <a href="#a962c3308c3d85963642c0ca1242d0ac7">More...</a><br /></td></tr>
<tr class="separator:a962c3308c3d85963642c0ca1242d0ac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d1193d7082b2272f46e63bc791871b"><td class="memItemLeft" align="right" valign="top">ON__UINT32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a63d1193d7082b2272f46e63bc791871b">CRC32</a> (ON__UINT32 current_remainder) const</td></tr>
<tr class="separator:a63d1193d7082b2272f46e63bc791871b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5c119332f2df68db38bc7046db3cdb0"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition</a> () const</td></tr>
<tr class="separator:aa5c119332f2df68db38bc7046db3cdb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5990b13e4e91ff7104c12e41e3f681cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a5990b13e4e91ff7104c12e41e3f681cf">Destroy</a> ()</td></tr>
<tr class="separator:a5990b13e4e91ff7104c12e41e3f681cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b92dc6a987dd14b5867a8d594b5d54c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a3b92dc6a987dd14b5867a8d594b5d54c">EmergencyDestroy</a> ()</td></tr>
<tr class="separator:a3b92dc6a987dd14b5867a8d594b5d54c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6278023f2d2b8f6b52094b855fbdd66"><td class="memItemLeft" align="right" valign="top">ON_Buffer_ErrorHandler&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ae6278023f2d2b8f6b52094b855fbdd66">ErrorHandler</a> () const</td></tr>
<tr class="separator:ae6278023f2d2b8f6b52094b855fbdd66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a527b9b97d73a3f361966f11004c77b8c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a527b9b97d73a3f361966f11004c77b8c">IsValid</a> (const <a class="el" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a> *text_log) const</td></tr>
<tr class="separator:a527b9b97d73a3f361966f11004c77b8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4eeec7923b5c00ac2a930f1ca22bc313"><td class="memItemLeft" align="right" valign="top">ON__UINT32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a4eeec7923b5c00ac2a930f1ca22bc313">LastError</a> () const</td></tr>
<tr class="separator:a4eeec7923b5c00ac2a930f1ca22bc313"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f94576d2644d545412748f3f47b4e02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a8f94576d2644d545412748f3f47b4e02">operator=</a> (const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;src)</td></tr>
<tr class="separator:a8f94576d2644d545412748f3f47b4e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade07e24604407bc13946604493190852"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ade07e24604407bc13946604493190852">Read</a> (ON__UINT64 size, void *buffer)</td></tr>
<tr class="separator:ade07e24604407bc13946604493190852"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2f22301086b369308341e48c2bc70bd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd">ReadFromBinaryArchive</a> (<a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &amp;)</td></tr>
<tr class="memdesc:aa2f22301086b369308341e48c2bc70bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd" title="Use ReadFromBinaryArchive() to retrieve an entire ON_Buffer that was written using WriteToBinaryArchi...">ReadFromBinaryArchive()</a> to retrieve an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> that was written using <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a" title="Use WriteToBinaryArchive() to save an entire ON_Buffer inside a binary archive. Use ReadFromBinaryArc...">WriteToBinaryArchive()</a>. <a href="#aa2f22301086b369308341e48c2bc70bd">More...</a><br /></td></tr>
<tr class="separator:aa2f22301086b369308341e48c2bc70bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab21bb47895df1d9c1ac028d7e980ed95"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ab21bb47895df1d9c1ac028d7e980ed95">Seek</a> (ON__INT64 offset, int origin)</td></tr>
<tr class="separator:ab21bb47895df1d9c1ac028d7e980ed95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae09b0bd4c728a0f2b7f4eb97e97dce48"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ae09b0bd4c728a0f2b7f4eb97e97dce48">SeekFromCurrentPosition</a> (ON__INT64 offset)</td></tr>
<tr class="separator:ae09b0bd4c728a0f2b7f4eb97e97dce48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf4319efff0ec798728edd44f306ed13"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#abf4319efff0ec798728edd44f306ed13">SeekFromEnd</a> (ON__INT64 offset)</td></tr>
<tr class="separator:abf4319efff0ec798728edd44f306ed13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac34b4ecc81c3f8ab7b0d591977b1f689"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ac34b4ecc81c3f8ab7b0d591977b1f689">SeekFromStart</a> (ON__INT64 offset)</td></tr>
<tr class="separator:ac34b4ecc81c3f8ab7b0d591977b1f689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c6413b608628fb3147238e39922f91d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a3c6413b608628fb3147238e39922f91d">SetErrorHandler</a> (ON_Buffer_ErrorHandler error_handler)</td></tr>
<tr class="separator:a3c6413b608628fb3147238e39922f91d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3b0f5eb7718c67ab6c741733ff520d2"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size</a> () const</td></tr>
<tr class="separator:ad3b0f5eb7718c67ab6c741733ff520d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aff04cf9629d75cd859d93f4f801cf8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a4aff04cf9629d75cd859d93f4f801cf8">Uncompress</a> (<a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;uncompressed_buffer) const</td></tr>
<tr class="memdesc:a4aff04cf9629d75cd859d93f4f801cf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uncompress this buffer which must have been compressed using <a class="el" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7" title="Compress this buffer ">ON_Buffer::Compress()</a>. <a href="#a4aff04cf9629d75cd859d93f4f801cf8">More...</a><br /></td></tr>
<tr class="separator:a4aff04cf9629d75cd859d93f4f801cf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7484357266d9bb7546d27f24ac96fe2d"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a7484357266d9bb7546d27f24ac96fe2d">Write</a> (ON__UINT64 size, const void *buffer)</td></tr>
<tr class="separator:a7484357266d9bb7546d27f24ac96fe2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ec84100d33a87ed3dc327166405717a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a">WriteToBinaryArchive</a> (<a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &amp;) const</td></tr>
<tr class="memdesc:a6ec84100d33a87ed3dc327166405717a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a" title="Use WriteToBinaryArchive() to save an entire ON_Buffer inside a binary archive. Use ReadFromBinaryArc...">WriteToBinaryArchive()</a> to save an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> inside a binary archive. Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd" title="Use ReadFromBinaryArchive() to retrieve an entire ON_Buffer that was written using WriteToBinaryArchi...">ReadFromBinaryArchive()</a> to retrieve the <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> from the <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>. <a href="#a6ec84100d33a87ed3dc327166405717a">More...</a><br /></td></tr>
<tr class="separator:a6ec84100d33a87ed3dc327166405717a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a168da7c4e4572c07a7ecc27006b92a28"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a168da7c4e4572c07a7ecc27006b92a28">Compare</a> (const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;a, const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;b)</td></tr>
<tr class="memdesc:a168da7c4e4572c07a7ecc27006b92a28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare contents of buffers. Paramters: a - [in] b - [in] <a href="#a168da7c4e4572c07a7ecc27006b92a28">More...</a><br /></td></tr>
<tr class="separator:a168da7c4e4572c07a7ecc27006b92a28"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a52f93f0eb0f5e0e1dd18fc21c60daf6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52f93f0eb0f5e0e1dd18fc21c60daf6e">&#9670;&nbsp;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a52f93f0eb0f5e0e1dd18fc21c60daf6ea352b035d364af17d28160dc99afd5198"></a>seek_from_beginning_of_file&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a52f93f0eb0f5e0e1dd18fc21c60daf6eab6ccec3d4f760ef1d489adb65b9d9529"></a>seek_from_current_position&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a52f93f0eb0f5e0e1dd18fc21c60daf6ea7e9c8bb05c0e70b98af45f70ca29138c"></a>seek_from_end_of_file&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a73055465dda25f22d75ad5587a5bdabd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73055465dda25f22d75ad5587a5bdabd">&#9670;&nbsp;</a></span>ON_Buffer() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_Buffer::ON_Buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa7681288987d91c8a4816b6dc8c64cc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7681288987d91c8a4816b6dc8c64cc2">&#9670;&nbsp;</a></span>~ON_Buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_Buffer::~ON_Buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a04b4b2453dc5ac21eed0fcdd93b44772"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04b4b2453dc5ac21eed0fcdd93b44772">&#9670;&nbsp;</a></span>ON_Buffer() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_Buffer::ON_Buffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a399e0b3b25725f8b64e3d0113102fe4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a399e0b3b25725f8b64e3d0113102fe4f">&#9670;&nbsp;</a></span>AtEnd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::AtEnd </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>True if <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> == <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>. </dd></dl>
<p>It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#a399e0b3b25725f8b64e3d0113102fe4f">AtEnd()</a> will return false. </p>
</div>
</div>
<a id="ac771b73243d8a308765a5d2e53f6a041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac771b73243d8a308765a5d2e53f6a041">&#9670;&nbsp;</a></span>ChangeSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::ChangeSize </td>
<td>(</td>
<td class="paramtype">ON__UINT64&#160;</td>
<td class="paramname"><em>buffer_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer_size</td><td>[in] new size of buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
<p>The current position is not changed and may be beyond the end of the file. Use Seek to set the current position after calling <a class="el" href="../../df/d05/class_o_n___buffer.html#ac771b73243d8a308765a5d2e53f6a041">ChangeSize()</a>. </p>
</div>
</div>
<a id="a774b8d06f510e12889725affe1e750bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a774b8d06f510e12889725affe1e750bc">&#9670;&nbsp;</a></span>ClearLastError()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Buffer::ClearLastError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab419542485bc354732e11b6134c1de2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab419542485bc354732e11b6134c1de2b">&#9670;&nbsp;</a></span>Compact()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::Compact </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return unused memory to heap. </p>
<p>Call this function after creating an <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> that will persist for and extended amount of time. There are never more than 16 pages of unsued memory (16*4096 bytes on most computers) in an <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a>. <a class="el" href="../../df/d05/class_o_n___buffer.html#ab419542485bc354732e11b6134c1de2b" title="Return unused memory to heap. ">Compact()</a> can be called at any time, but calling <a class="el" href="../../df/d05/class_o_n___buffer.html#ab419542485bc354732e11b6134c1de2b" title="Return unused memory to heap. ">Compact()</a> the then writing at the end of the buffer is not an efficient use of time or memory. </p>
</div>
</div>
<a id="a168da7c4e4572c07a7ecc27006b92a28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a168da7c4e4572c07a7ecc27006b92a28">&#9670;&nbsp;</a></span>Compare()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int ON_Buffer::Compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;&#160;</td>
<td class="paramname"><em>b</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare contents of buffers. Paramters: a - [in] b - [in] </p>
<dl class="section return"><dt>Returns</dt><dd>-1: a &lt; b 0: a == b 1: a &gt; b </dd></dl>
</div>
</div>
<a id="a962c3308c3d85963642c0ca1242d0ac7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a962c3308c3d85963642c0ca1242d0ac7">&#9670;&nbsp;</a></span>Compress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::Compress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;&#160;</td>
<td class="paramname"><em>compressed_buffer</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compress this buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">compressed_buffer</td><td>[out] (The reference can be *this) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if failed. </dd></dl>
<div class="fragment"><div class="line">@verbatim</div><div class="line"> <span class="comment">// compress a buffer in place</span></div><div class="line"> <a class="code" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> buffer;</div><div class="line"> buffer = ...;</div><div class="line"> <span class="keywordflow">if</span> ( !buffer.Compress(buffer) )</div><div class="line"> {</div><div class="line"> <span class="comment">// compression failed</span></div><div class="line"> }</div><div class="line"> <span class="keywordflow">else</span></div><div class="line"> {</div><div class="line"> <span class="comment">// buffer is now compressed</span></div><div class="line"> }</div><div class="line"><span class="keyword">@end</span>verbatim</div></div><!-- fragment -->
</div>
</div>
<a id="a63d1193d7082b2272f46e63bc791871b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63d1193d7082b2272f46e63bc791871b">&#9670;&nbsp;</a></span>CRC32()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT32 ON_Buffer::CRC32 </td>
<td>(</td>
<td class="paramtype">ON__UINT32&#160;</td>
<td class="paramname"><em>current_remainder</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>32-bit CRC of the buffer contents. </dd></dl>
</div>
</div>
<a id="aa5c119332f2df68db38bc7046db3cdb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5c119332f2df68db38bc7046db3cdb0">&#9670;&nbsp;</a></span>CurrentPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT64 ON_Buffer::CurrentPosition </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 position in the buffer. </dd></dl>
<p>It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> will be greater than <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>. </p>
</div>
</div>
<a id="a5990b13e4e91ff7104c12e41e3f681cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5990b13e4e91ff7104c12e41e3f681cf">&#9670;&nbsp;</a></span>Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Buffer::Destroy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3b92dc6a987dd14b5867a8d594b5d54c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b92dc6a987dd14b5867a8d594b5d54c">&#9670;&nbsp;</a></span>EmergencyDestroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Buffer::EmergencyDestroy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae6278023f2d2b8f6b52094b855fbdd66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6278023f2d2b8f6b52094b855fbdd66">&#9670;&nbsp;</a></span>ErrorHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_Buffer_ErrorHandler ON_Buffer::ErrorHandler </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a527b9b97d73a3f361966f11004c77b8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a527b9b97d73a3f361966f11004c77b8c">&#9670;&nbsp;</a></span>IsValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::IsValid </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a> *&#160;</td>
<td class="paramname"><em>text_log</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4eeec7923b5c00ac2a930f1ca22bc313"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eeec7923b5c00ac2a930f1ca22bc313">&#9670;&nbsp;</a></span>LastError()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT32 ON_Buffer::LastError </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>Value that identifies most recent error. 0: no error 1: attempt to seek to a negative position </dd></dl>
</div>
</div>
<a id="a8f94576d2644d545412748f3f47b4e02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f94576d2644d545412748f3f47b4e02">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a>&amp; ON_Buffer::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ade07e24604407bc13946604493190852"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade07e24604407bc13946604493190852">&#9670;&nbsp;</a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT64 ON_Buffer::Read </td>
<td>(</td>
<td class="paramtype">ON__UINT64&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>[in] number of bytes to read.</td></tr>
<tr><td class="paramname">buffer</td><td>[out] read values are returned in buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes read into buffer. For example, if <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &lt;= <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> and size &gt; (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) and buffer is not null, then the value (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) is returned. </dd></dl>
<p>If the size parameter is zero, then nothing is done. When <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &lt;= <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>, attempts to read more than (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) bytes do not generate an error. When <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &gt; <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>, any attempt to read generates an error. </p>
</div>
</div>
<a id="aa2f22301086b369308341e48c2bc70bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2f22301086b369308341e48c2bc70bd">&#9670;&nbsp;</a></span>ReadFromBinaryArchive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::ReadFromBinaryArchive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd" title="Use ReadFromBinaryArchive() to retrieve an entire ON_Buffer that was written using WriteToBinaryArchi...">ReadFromBinaryArchive()</a> to retrieve an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> that was written using <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a" title="Use WriteToBinaryArchive() to save an entire ON_Buffer inside a binary archive. Use ReadFromBinaryArc...">WriteToBinaryArchive()</a>. </p>
</div>
</div>
<a id="ab21bb47895df1d9c1ac028d7e980ed95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab21bb47895df1d9c1ac028d7e980ed95">&#9670;&nbsp;</a></span>Seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::Seek </td>
<td>(</td>
<td class="paramtype">ON__INT64&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>origin</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>[in] number of bytes to seek from origin</td></tr>
<tr><td class="paramname">origin</td><td>[in] initial position. 0 (SEEK_SET) Seek from beginning of file. 1 (SEEK_CUR) Seek from current position. 2 (SEEK_END) Seek from end of file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. </dd></dl>
<p>Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
</div>
</div>
<a id="ae09b0bd4c728a0f2b7f4eb97e97dce48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae09b0bd4c728a0f2b7f4eb97e97dce48">&#9670;&nbsp;</a></span>SeekFromCurrentPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::SeekFromCurrentPosition </td>
<td>(</td>
<td class="paramtype">ON__INT64&#160;</td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>[in] number of bytes to seek from the current position.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. </dd></dl>
<p>Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
</div>
</div>
<a id="abf4319efff0ec798728edd44f306ed13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf4319efff0ec798728edd44f306ed13">&#9670;&nbsp;</a></span>SeekFromEnd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::SeekFromEnd </td>
<td>(</td>
<td class="paramtype">ON__INT64&#160;</td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>[in] number of bytes to seek from the end fo the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. </dd></dl>
<p>Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
</div>
</div>
<a id="ac34b4ecc81c3f8ab7b0d591977b1f689"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac34b4ecc81c3f8ab7b0d591977b1f689">&#9670;&nbsp;</a></span>SeekFromStart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::SeekFromStart </td>
<td>(</td>
<td class="paramtype">ON__INT64&#160;</td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>[in] (&gt;= 0) number of bytes to seek from the start of the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. </dd></dl>
<p>Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
</div>
</div>
<a id="a3c6413b608628fb3147238e39922f91d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c6413b608628fb3147238e39922f91d">&#9670;&nbsp;</a></span>SetErrorHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Buffer::SetErrorHandler </td>
<td>(</td>
<td class="paramtype">ON_Buffer_ErrorHandler&#160;</td>
<td class="paramname"><em>error_handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad3b0f5eb7718c67ab6c741733ff520d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3b0f5eb7718c67ab6c741733ff520d2">&#9670;&nbsp;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT64 ON_Buffer::Size </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>Number of bytes currently in the buffer. </dd></dl>
<p>It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> will be greater than <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>. </p>
</div>
</div>
<a id="a4aff04cf9629d75cd859d93f4f801cf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aff04cf9629d75cd859d93f4f801cf8">&#9670;&nbsp;</a></span>Uncompress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::Uncompress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;&#160;</td>
<td class="paramname"><em>uncompressed_buffer</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Uncompress this buffer which must have been compressed using <a class="el" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7" title="Compress this buffer ">ON_Buffer::Compress()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uncompressed_buffer</td><td>[out] (The reference can be *this) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if failed. </dd></dl>
<div class="fragment"><div class="line"><span class="comment">// silly example that compresses and then uncompresses a buffer in place</span></div><div class="line"><span class="comment">// to show how to call the functions.</span></div><div class="line"><a class="code" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> buffer;</div><div class="line">buffer = ...; <span class="comment">// buffer is in it uncompressed form</span></div><div class="line"><span class="keywordflow">if</span> ( buffer.<a class="code" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7">Compress</a>(buffer) )</div><div class="line">{</div><div class="line"> <span class="comment">// buffer is now compressed</span></div><div class="line"> <span class="keywordflow">if</span> ( buffer.<a class="code" href="../../df/d05/class_o_n___buffer.html#a4aff04cf9629d75cd859d93f4f801cf8">Uncompress</a>(buffer) )</div><div class="line"> {</div><div class="line"> <span class="comment">// buffer is uncompressed again.</span></div><div class="line"> }</div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="a7484357266d9bb7546d27f24ac96fe2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7484357266d9bb7546d27f24ac96fe2d">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON__UINT64 ON_Buffer::Write </td>
<td>(</td>
<td class="paramtype">ON__UINT64&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>buffer</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>[in] number of bytes to write.</td></tr>
<tr><td class="paramname">buffer</td><td>[in] values to write.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written buffer. </dd></dl>
</div>
</div>
<a id="a6ec84100d33a87ed3dc327166405717a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ec84100d33a87ed3dc327166405717a">&#9670;&nbsp;</a></span>WriteToBinaryArchive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_Buffer::WriteToBinaryArchive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a" title="Use WriteToBinaryArchive() to save an entire ON_Buffer inside a binary archive. Use ReadFromBinaryArc...">WriteToBinaryArchive()</a> to save an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> inside a binary archive. Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd" title="Use ReadFromBinaryArchive() to retrieve an entire ON_Buffer that was written using WriteToBinaryArchi...">ReadFromBinaryArchive()</a> to retrieve the <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> from the <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>. </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>
Reference in New Issue View Git Blame Copy Permalink