lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-04-02 01:16:49 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
832ccb5c1aa0e9513081163bbbc5b4aa4e306227
opennurbs/6/dd/da7/class_o_n___file_stream.html
Bozo 832ccb5c1a Publish! 
Generated from v6.0.11315.11111-test14
2018-02-03 11:08:49 -08:00

918 lines
42 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_FileStream 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-static-methods">Static Public Member Functions</a> &#124;
<a href="../../dc/d70/class_o_n___file_stream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_FileStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d6/da3/opennurbs__file__utilities_8h_source.html">opennurbs_file_utilities.h</a>&gt;</code></p>
<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:a519b0b8ae279eae9834a3433c11bc54c"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a519b0b8ae279eae9834a3433c11bc54c">Close</a> (FILE *fp)</td></tr>
<tr class="memdesc:a519b0b8ae279eae9834a3433c11bc54c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fclose(). <a href="#a519b0b8ae279eae9834a3433c11bc54c">More...</a><br /></td></tr>
<tr class="separator:a519b0b8ae279eae9834a3433c11bc54c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add50a7643172810ee33d0d0ecb2f525d"><td class="memItemLeft" align="right" valign="top">static ON__INT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#add50a7643172810ee33d0d0ecb2f525d">CurrentPosition</a> (FILE *fp)</td></tr>
<tr class="memdesc:add50a7643172810ee33d0d0ecb2f525d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime ftell(). <a href="#add50a7643172810ee33d0d0ecb2f525d">More...</a><br /></td></tr>
<tr class="separator:add50a7643172810ee33d0d0ecb2f525d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f69c07a76f7c6d2bb85c2a421a14f30"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a5f69c07a76f7c6d2bb85c2a421a14f30">Flush</a> (FILE *fp)</td></tr>
<tr class="memdesc:a5f69c07a76f7c6d2bb85c2a421a14f30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fflush(fp). <a href="#a5f69c07a76f7c6d2bb85c2a421a14f30">More...</a><br /></td></tr>
<tr class="separator:a5f69c07a76f7c6d2bb85c2a421a14f30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac344f0e78881d31fe07aa99f63955700"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#ac344f0e78881d31fe07aa99f63955700">GetFileInformation</a> (FILE *fp, ON__UINT64 *file_size, ON__UINT64 *file_metadata_last_modified_time, ON__UINT64 *file_contents_last_modified_time)</td></tr>
<tr class="memdesc:ac344f0e78881d31fe07aa99f63955700"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fstat(). <a href="#ac344f0e78881d31fe07aa99f63955700">More...</a><br /></td></tr>
<tr class="separator:ac344f0e78881d31fe07aa99f63955700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33ab4bdb97185c9c2849ab3de2bd2ef9"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a33ab4bdb97185c9c2849ab3de2bd2ef9">GetFileInformation</a> (const wchar_t *file_name, ON__UINT64 *file_size, ON__UINT64 *file_metadata_last_modified_time, ON__UINT64 *file_contents_last_modified_time)</td></tr>
<tr class="separator:a33ab4bdb97185c9c2849ab3de2bd2ef9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab53e9d962a923fc1b460a9f4cfda3505"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#ab53e9d962a923fc1b460a9f4cfda3505">GetFileInformation</a> (const char *file_name, ON__UINT64 *file_size, ON__UINT64 *file_metadata_last_modified_time, ON__UINT64 *file_contents_last_modified_time)</td></tr>
<tr class="separator:ab53e9d962a923fc1b460a9f4cfda3505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9cdf39763ac798065e87777d756cf0"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a6d9cdf39763ac798065e87777d756cf0">Is3dmFile</a> (const wchar_t *file_path, bool bAllow3dmbakExtension)</td></tr>
<tr class="separator:a6d9cdf39763ac798065e87777d756cf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c4125addb09e08fab20dd9c4f9e9bc0"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a6c4125addb09e08fab20dd9c4f9e9bc0">Is3dmFile</a> (const char *file_path, bool bAllow3dmbakExtension)</td></tr>
<tr class="separator:a6c4125addb09e08fab20dd9c4f9e9bc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09e4b43c9176ae7854ba10e5d21b2923"><td class="memItemLeft" align="right" valign="top">static FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923">Open</a> (const wchar_t *filename, const wchar_t *mode)</td></tr>
<tr class="memdesc:a09e4b43c9176ae7854ba10e5d21b2923"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fopen(). <a href="#a09e4b43c9176ae7854ba10e5d21b2923">More...</a><br /></td></tr>
<tr class="separator:a09e4b43c9176ae7854ba10e5d21b2923"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d1c367f44712b6f4c9893fd27b64809"><td class="memItemLeft" align="right" valign="top">static FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a8d1c367f44712b6f4c9893fd27b64809">Open</a> (const char *filename, const char *mode)</td></tr>
<tr class="memdesc:a8d1c367f44712b6f4c9893fd27b64809"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fopen(). <a href="#a8d1c367f44712b6f4c9893fd27b64809">More...</a><br /></td></tr>
<tr class="separator:a8d1c367f44712b6f4c9893fd27b64809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1d36151bf1f7b2e929bb3c66b75ee84"><td class="memItemLeft" align="right" valign="top">static FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#ad1d36151bf1f7b2e929bb3c66b75ee84">Open3dmToRead</a> (const wchar_t *file_path)</td></tr>
<tr class="memdesc:ad1d36151bf1f7b2e929bb3c66b75ee84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the file and seek to the location where the 3dm archive information begins. <a href="#ad1d36151bf1f7b2e929bb3c66b75ee84">More...</a><br /></td></tr>
<tr class="separator:ad1d36151bf1f7b2e929bb3c66b75ee84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e8096ef66fd340f21ffa74be51a4ed2"><td class="memItemLeft" align="right" valign="top">static FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a5e8096ef66fd340f21ffa74be51a4ed2">Open3dmToRead</a> (const char *file_path)</td></tr>
<tr class="memdesc:a5e8096ef66fd340f21ffa74be51a4ed2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the file and seek to the location where the 3dm archive information begins. <a href="#a5e8096ef66fd340f21ffa74be51a4ed2">More...</a><br /></td></tr>
<tr class="separator:a5e8096ef66fd340f21ffa74be51a4ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c5b133a8e2dc437b1b3503affe71720"><td class="memItemLeft" align="right" valign="top">static ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a1c5b133a8e2dc437b1b3503affe71720">Read</a> (FILE *fp, ON__UINT64 count, void *buffer)</td></tr>
<tr class="memdesc:a1c5b133a8e2dc437b1b3503affe71720"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fread(buffer,1,count,fp). <a href="#a1c5b133a8e2dc437b1b3503affe71720">More...</a><br /></td></tr>
<tr class="separator:a1c5b133a8e2dc437b1b3503affe71720"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66d97d2c066287152be5d9e36774263e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a66d97d2c066287152be5d9e36774263e">Seek</a> (FILE *fp, ON__INT64 offset, int orgin)</td></tr>
<tr class="memdesc:a66d97d2c066287152be5d9e36774263e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fseek(fp,offset,origin). <a href="#a66d97d2c066287152be5d9e36774263e">More...</a><br /></td></tr>
<tr class="separator:a66d97d2c066287152be5d9e36774263e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dda2d298aff228e3b4c140a99f19224"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a3dda2d298aff228e3b4c140a99f19224">SeekFromCurrentPosition</a> (FILE *fp, ON__INT64 offset)</td></tr>
<tr class="memdesc:a3dda2d298aff228e3b4c140a99f19224"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fseek(fp,offset,SEEK_CUR). <a href="#a3dda2d298aff228e3b4c140a99f19224">More...</a><br /></td></tr>
<tr class="separator:a3dda2d298aff228e3b4c140a99f19224"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c32b4d7e7e4848b1e352b0a57bbfda9"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a1c32b4d7e7e4848b1e352b0a57bbfda9">SeekFromEnd</a> (FILE *fp, ON__INT64 offset)</td></tr>
<tr class="memdesc:a1c32b4d7e7e4848b1e352b0a57bbfda9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fseek(fp,offset,SEEK_END). <a href="#a1c32b4d7e7e4848b1e352b0a57bbfda9">More...</a><br /></td></tr>
<tr class="separator:a1c32b4d7e7e4848b1e352b0a57bbfda9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c3cc28af5c0cc7c7e2f473bf0fbafb9"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a6c3cc28af5c0cc7c7e2f473bf0fbafb9">SeekFromStart</a> (FILE *fp, ON__INT64 offset)</td></tr>
<tr class="memdesc:a6c3cc28af5c0cc7c7e2f473bf0fbafb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fseek(fp,offset,SEEK_SET). <a href="#a6c3cc28af5c0cc7c7e2f473bf0fbafb9">More...</a><br /></td></tr>
<tr class="separator:a6c3cc28af5c0cc7c7e2f473bf0fbafb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d41d3911f86a6f203b12622df756d9e"><td class="memItemLeft" align="right" valign="top">static ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da7/class_o_n___file_stream.html#a4d41d3911f86a6f203b12622df756d9e">Write</a> (FILE *fp, ON__UINT64 count, const void *buffer)</td></tr>
<tr class="memdesc:a4d41d3911f86a6f203b12622df756d9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Portable wrapper for C runtime fwrite(buffer,1,count,fp). <a href="#a4d41d3911f86a6f203b12622df756d9e">More...</a><br /></td></tr>
<tr class="separator:a4d41d3911f86a6f203b12622df756d9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a519b0b8ae279eae9834a3433c11bc54c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a519b0b8ae279eae9834a3433c11bc54c">&#9670;&nbsp;</a></span>Close()</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_FileStream::Close </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em></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>Portable wrapper for C runtime fclose(). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0: successful -1: null fp parameter != 0: fclose() failure code </dd></dl>
</div>
</div>
<a id="add50a7643172810ee33d0d0ecb2f525d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add50a7643172810ee33d0d0ecb2f525d">&#9670;&nbsp;</a></span>CurrentPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static ON__INT64 ON_FileStream::CurrentPosition </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em></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>Portable wrapper for C runtime ftell(). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>&gt;= 0: current file position -1: an error occured </dd></dl>
</div>
</div>
<a id="a5f69c07a76f7c6d2bb85c2a421a14f30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f69c07a76f7c6d2bb85c2a421a14f30">&#9670;&nbsp;</a></span>Flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::Flush </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em></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>Portable wrapper for C runtime fflush(fp). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if flush was successful. False if an error occured. </dd></dl>
</div>
</div>
<a id="ac344f0e78881d31fe07aa99f63955700"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac344f0e78881d31fe07aa99f63955700">&#9670;&nbsp;</a></span>GetFileInformation() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::GetFileInformation </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_metadata_last_modified_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_contents_last_modified_time</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>Portable wrapper for C runtime fstat(). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a>.</td></tr>
<tr><td class="paramname">file_size</td><td>[out] If file_size is not null, the the size of the file in bytes returned here</td></tr>
<tr><td class="paramname">file_metadata_last_modified_time</td><td>[out] If file_metadata_last_modified_time is not null, then the time the file's metadata (owner, permissions, ...) were last modified is returned here as the number of seconds since midnight January 1, 1970.</td></tr>
<tr><td class="paramname">file_contents_last_modified_time</td><td>[out] If file_contents_last_modified_time is not null, then the time the file's contents were last modified is returned here as the number of seconds since midnight January 1, 1970.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the query was successful. False if an error occured. </dd></dl>
</div>
</div>
<a id="a33ab4bdb97185c9c2849ab3de2bd2ef9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33ab4bdb97185c9c2849ab3de2bd2ef9">&#9670;&nbsp;</a></span>GetFileInformation() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::GetFileInformation </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>file_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_metadata_last_modified_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_contents_last_modified_time</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">
</div>
</div>
<a id="ab53e9d962a923fc1b460a9f4cfda3505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab53e9d962a923fc1b460a9f4cfda3505">&#9670;&nbsp;</a></span>GetFileInformation() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::GetFileInformation </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_metadata_last_modified_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64 *&#160;</td>
<td class="paramname"><em>file_contents_last_modified_time</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">
</div>
</div>
<a id="a6d9cdf39763ac798065e87777d756cf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d9cdf39763ac798065e87777d756cf0">&#9670;&nbsp;</a></span>Is3dmFile() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::Is3dmFile </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>file_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>bAllow3dmbakExtension</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">
<dl class="section return"><dt>Returns</dt><dd>True if the file is a 3dm archive. </dd></dl>
</div>
</div>
<a id="a6c4125addb09e08fab20dd9c4f9e9bc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c4125addb09e08fab20dd9c4f9e9bc0">&#9670;&nbsp;</a></span>Is3dmFile() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::Is3dmFile </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>bAllow3dmbakExtension</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">
<dl class="section return"><dt>Returns</dt><dd>True if the file is a 3dm archive. </dd></dl>
</div>
</div>
<a id="a09e4b43c9176ae7854ba10e5d21b2923"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09e4b43c9176ae7854ba10e5d21b2923">&#9670;&nbsp;</a></span>Open() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static FILE* ON_FileStream::Open </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>mode</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>Portable wrapper for C runtime fopen(). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>[in]</td></tr>
<tr><td class="paramname">mode</td><td>[in]</td></tr>
</table>
</dd>
</dl>
<p>Use the <a class="el" href="../../dd/da7/class_o_n___file_stream.html">ON_FileStream</a> static functions for reading, writing, seeking, position finding with the FILE pointer returned by this function. </p>
</div>
</div>
<a id="a8d1c367f44712b6f4c9893fd27b64809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d1c367f44712b6f4c9893fd27b64809">&#9670;&nbsp;</a></span>Open() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static FILE* ON_FileStream::Open </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>mode</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>Portable wrapper for C runtime fopen(). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>[in]</td></tr>
<tr><td class="paramname">mode</td><td>[in]</td></tr>
</table>
</dd>
</dl>
<p>Use the <a class="el" href="../../dd/da7/class_o_n___file_stream.html">ON_FileStream</a> static functions for reading, writing, seeking, position finding with the FILE pointer returned by this function. </p>
</div>
</div>
<a id="ad1d36151bf1f7b2e929bb3c66b75ee84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1d36151bf1f7b2e929bb3c66b75ee84">&#9670;&nbsp;</a></span>Open3dmToRead() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static FILE* ON_FileStream::Open3dmToRead </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>file_path</em></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>Open the file and seek to the location where the 3dm archive information begins. </p>
<dl class="section return"><dt>Returns</dt><dd>A file stream with the current position at the beginning of the 3dm archive. nullptr if the file is not a 3dm archive. </dd></dl>
</div>
</div>
<a id="a5e8096ef66fd340f21ffa74be51a4ed2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e8096ef66fd340f21ffa74be51a4ed2">&#9670;&nbsp;</a></span>Open3dmToRead() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static FILE* ON_FileStream::Open3dmToRead </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file_path</em></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>Open the file and seek to the location where the 3dm archive information begins. </p>
<dl class="section return"><dt>Returns</dt><dd>A file stream with the current position at the beginning of the 3dm archive. nullptr if the file is not a 3dm archive. </dd></dl>
</div>
</div>
<a id="a1c5b133a8e2dc437b1b3503affe71720"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c5b133a8e2dc437b1b3503affe71720">&#9670;&nbsp;</a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static ON__UINT64 ON_FileStream::Read </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64&#160;</td>
<td class="paramname"><em>count</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Portable wrapper for C runtime fread(buffer,1,count,fp). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a></td></tr>
<tr><td class="paramname">count</td><td>[in] number of bytes to read.</td></tr>
<tr><td class="paramname">buffer</td><td>[out] read bytes are stored in this buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of bytes read </dd></dl>
</div>
</div>
<a id="a66d97d2c066287152be5d9e36774263e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66d97d2c066287152be5d9e36774263e">&#9670;&nbsp;</a></span>Seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::Seek </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>orgin</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>Portable wrapper for C runtime fseek(fp,offset,origin). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a>.</td></tr>
<tr><td class="paramname">offset</td><td>[in]</td></tr>
<tr><td class="paramname">origin</td><td>[in] SEEK_SET (0): seek from beginning of file. SEEK_CUR (1): seek from current position of file pointer. SEEK_END (2): seek from end of file.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3dda2d298aff228e3b4c140a99f19224"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dda2d298aff228e3b4c140a99f19224">&#9670;&nbsp;</a></span>SeekFromCurrentPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::SeekFromCurrentPosition </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__INT64&#160;</td>
<td class="paramname"><em>offset</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>Portable wrapper for C runtime fseek(fp,offset,SEEK_CUR). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a>.</td></tr>
<tr><td class="paramname">offset</td><td>[in]</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1c32b4d7e7e4848b1e352b0a57bbfda9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c32b4d7e7e4848b1e352b0a57bbfda9">&#9670;&nbsp;</a></span>SeekFromEnd()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::SeekFromEnd </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__INT64&#160;</td>
<td class="paramname"><em>offset</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>Portable wrapper for C runtime fseek(fp,offset,SEEK_END). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a>.</td></tr>
<tr><td class="paramname">offset</td><td>[in]</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6c3cc28af5c0cc7c7e2f473bf0fbafb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c3cc28af5c0cc7c7e2f473bf0fbafb9">&#9670;&nbsp;</a></span>SeekFromStart()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_FileStream::SeekFromStart </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__INT64&#160;</td>
<td class="paramname"><em>offset</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>Portable wrapper for C runtime fseek(fp,offset,SEEK_SET). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a>.</td></tr>
<tr><td class="paramname">offset</td><td>[in]</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4d41d3911f86a6f203b12622df756d9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d41d3911f86a6f203b12622df756d9e">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static ON__UINT64 ON_FileStream::Write </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT64&#160;</td>
<td class="paramname"><em>count</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Portable wrapper for C runtime fwrite(buffer,1,count,fp). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>[in] FILE pointer returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923" title="Portable wrapper for C runtime fopen(). ">ON_FileStream::Open()</a></td></tr>
<tr><td class="paramname">count</td><td>[in] number of bytes to write</td></tr>
<tr><td class="paramname">buffer</td><td>[in] data to be written</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of bytes written. </dd></dl>
</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:30 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