Files
opennurbs/6/db/d70/class_o_n___file_system.html
Bozo 832ccb5c1a Publish!
Generated from v6.0.11315.11111-test14
2018-02-03 11:08:49 -08:00

390 lines
17 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_FileSystem 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="../../d2/df5/class_o_n___file_system-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_FileSystem 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:a7189de05b2c82baf5bb153586127485d"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a7189de05b2c82baf5bb153586127485d">IsDirectory</a> (const char *path)</td></tr>
<tr class="separator:a7189de05b2c82baf5bb153586127485d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c34ed19598a225050b1772d4a917ec6"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a6c34ed19598a225050b1772d4a917ec6">IsDirectory</a> (const wchar_t *path)</td></tr>
<tr class="separator:a6c34ed19598a225050b1772d4a917ec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1aa84a76b6fc45a1d60ba0dfad37861d"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a1aa84a76b6fc45a1d60ba0dfad37861d">IsDirectoryWithWriteAccess</a> (const char *path)</td></tr>
<tr class="separator:a1aa84a76b6fc45a1d60ba0dfad37861d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3afc4f5cbce13337b64fca20d635ceba"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a3afc4f5cbce13337b64fca20d635ceba">IsDirectoryWithWriteAccess</a> (const wchar_t *path)</td></tr>
<tr class="separator:a3afc4f5cbce13337b64fca20d635ceba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a463c1f32f5cf15ff26d5123da4a5c5e8"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a463c1f32f5cf15ff26d5123da4a5c5e8">IsFile</a> (const char *path)</td></tr>
<tr class="separator:a463c1f32f5cf15ff26d5123da4a5c5e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a891d890ecd1ffb5a5221817969f2d998"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a891d890ecd1ffb5a5221817969f2d998">IsFile</a> (const wchar_t *path)</td></tr>
<tr class="separator:a891d890ecd1ffb5a5221817969f2d998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5329e570f58c8ba8932a468b4a666e1e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a5329e570f58c8ba8932a468b4a666e1e">PathExists</a> (const char *path)</td></tr>
<tr class="separator:a5329e570f58c8ba8932a468b4a666e1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75844221ca2d01cbdcd96afdf080cc32"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a75844221ca2d01cbdcd96afdf080cc32">PathExists</a> (const wchar_t *path)</td></tr>
<tr class="separator:a75844221ca2d01cbdcd96afdf080cc32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b064c9ed525785dca4c4b39fb2f0e24"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#a7b064c9ed525785dca4c4b39fb2f0e24">RemoveFile</a> (const char *file_path)</td></tr>
<tr class="separator:a7b064c9ed525785dca4c4b39fb2f0e24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf30ab4a67e1e5d7a9ccf3671426e582"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d70/class_o_n___file_system.html#acf30ab4a67e1e5d7a9ccf3671426e582">RemoveFile</a> (const wchar_t *file_path)</td></tr>
<tr class="separator:acf30ab4a67e1e5d7a9ccf3671426e582"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7189de05b2c82baf5bb153586127485d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7189de05b2c82baf5bb153586127485d">&#9670;&nbsp;</a></span>IsDirectory() <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_FileSystem::IsDirectory </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>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">
<dl class="section return"><dt>Returns</dt><dd>True if path is a directory. False otherwise. </dd></dl>
</div>
</div>
<a id="a6c34ed19598a225050b1772d4a917ec6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c34ed19598a225050b1772d4a917ec6">&#9670;&nbsp;</a></span>IsDirectory() <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_FileSystem::IsDirectory </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>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">
<dl class="section return"><dt>Returns</dt><dd>True if path is a directory. False otherwise. </dd></dl>
</div>
</div>
<a id="a1aa84a76b6fc45a1d60ba0dfad37861d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1aa84a76b6fc45a1d60ba0dfad37861d">&#9670;&nbsp;</a></span>IsDirectoryWithWriteAccess() <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_FileSystem::IsDirectoryWithWriteAccess </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>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">
<dl class="section return"><dt>Returns</dt><dd>True if path is a directory where files can be written. False otherwise. </dd></dl>
</div>
</div>
<a id="a3afc4f5cbce13337b64fca20d635ceba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3afc4f5cbce13337b64fca20d635ceba">&#9670;&nbsp;</a></span>IsDirectoryWithWriteAccess() <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_FileSystem::IsDirectoryWithWriteAccess </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>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">
<dl class="section return"><dt>Returns</dt><dd>True if path is a directory where files can be written. False otherwise. </dd></dl>
</div>
</div>
<a id="a463c1f32f5cf15ff26d5123da4a5c5e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a463c1f32f5cf15ff26d5123da4a5c5e8">&#9670;&nbsp;</a></span>IsFile() <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_FileSystem::IsFile </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>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">
<dl class="section return"><dt>Returns</dt><dd>True if path is a file. False otherwise. </dd></dl>
</div>
</div>
<a id="a891d890ecd1ffb5a5221817969f2d998"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a891d890ecd1ffb5a5221817969f2d998">&#9670;&nbsp;</a></span>IsFile() <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_FileSystem::IsFile </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>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">
<dl class="section return"><dt>Returns</dt><dd>True if path is a file. False otherwise. </dd></dl>
</div>
</div>
<a id="a5329e570f58c8ba8932a468b4a666e1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5329e570f58c8ba8932a468b4a666e1e">&#9670;&nbsp;</a></span>PathExists() <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_FileSystem::PathExists </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>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">
</div>
</div>
<a id="a75844221ca2d01cbdcd96afdf080cc32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75844221ca2d01cbdcd96afdf080cc32">&#9670;&nbsp;</a></span>PathExists() <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_FileSystem::PathExists </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>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">
</div>
</div>
<a id="a7b064c9ed525785dca4c4b39fb2f0e24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b064c9ed525785dca4c4b39fb2f0e24">&#9670;&nbsp;</a></span>RemoveFile() <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_FileSystem::RemoveFile </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">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_path</td><td>[in] name of file to delete</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the fuke existed and was removed. </dd></dl>
</div>
</div>
<a id="acf30ab4a67e1e5d7a9ccf3671426e582"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf30ab4a67e1e5d7a9ccf3671426e582">&#9670;&nbsp;</a></span>RemoveFile() <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_FileSystem::RemoveFile </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">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_path</td><td>[in] name of file to delete</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the fuke existed and was removed. </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>