mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-04-02 01:16:49 +08:00
501 lines
28 KiB
HTML
501 lines
28 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_FileIterator Class Reference</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<!-- <script type="text/javascript" src="../../jquery.js"></script> -->
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<!-- bootstrap -->
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
|
|
<!-- smartmenus -->
|
|
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
|
|
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
|
|
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
|
|
</head>
|
|
<body>
|
|
<!-- <div class="version-banner">
|
|
Go back to the <a href="/">main site</a>...
|
|
</div> -->
|
|
<div class="container">
|
|
<!-- navbar -->
|
|
<nav class="navbar navbar-default">
|
|
<div class="container-fluid">
|
|
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
|
|
<div class="navbar-collapse collapse" id="main-nav-placeholder">
|
|
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">Latest (6.x)</a></li>
|
|
<li class="disabled"><a href="#">WIP (7.x)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="page-content">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="../../d1/de2/class_o_n___file_iterator-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ON_FileIterator Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Iterates through every item in a file system directory.
|
|
<a href="../../d5/db7/class_o_n___file_iterator.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="../../d6/da3/opennurbs__file__utilities_8h_source.html">opennurbs_file_utilities.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a3f019250af476aa9eef3f27042228238"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a3f019250af476aa9eef3f27042228238">ON_FileIterator</a> ()=default</td></tr>
|
|
<tr class="separator:a3f019250af476aa9eef3f27042228238"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d9be2bf6d82bf811d5b46bcc22b2d1e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a4d9be2bf6d82bf811d5b46bcc22b2d1e">~ON_FileIterator</a> ()</td></tr>
|
|
<tr class="separator:a4d9be2bf6d82bf811d5b46bcc22b2d1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0532d70638788a817bdbe1fbf9b8e6d9"><td class="memItemLeft" align="right" valign="top">ON__UINT64 </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a0532d70638788a817bdbe1fbf9b8e6d9">CurrentItemCount</a> () const</td></tr>
|
|
<tr class="separator:a0532d70638788a817bdbe1fbf9b8e6d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae48ad7e53caeed626d34813e572f50e0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#ae48ad7e53caeed626d34813e572f50e0">CurrentItemFullPathName</a> () const</td></tr>
|
|
<tr class="separator:ae48ad7e53caeed626d34813e572f50e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56d27043026dacf1b76798e0e459e3f5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a56d27043026dacf1b76798e0e459e3f5">CurrentItemIsDirectory</a> () const</td></tr>
|
|
<tr class="separator:a56d27043026dacf1b76798e0e459e3f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9ea0b74070a1aaa1ae6da324d57a95a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#af9ea0b74070a1aaa1ae6da324d57a95a">CurrentItemIsFile</a> () const</td></tr>
|
|
<tr class="separator:af9ea0b74070a1aaa1ae6da324d57a95a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1f9e8e24468037be466501d6e199eca"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#ac1f9e8e24468037be466501d6e199eca">CurrentItemIsHidden</a> () const</td></tr>
|
|
<tr class="separator:ac1f9e8e24468037be466501d6e199eca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1051ddd0cc652eeb3f2322ebb6c9c1c2"><td class="memItemLeft" align="right" valign="top">ON__UINT64 </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a1051ddd0cc652eeb3f2322ebb6c9c1c2">CurrentItemLastModifiedTime</a> () const</td></tr>
|
|
<tr class="separator:a1051ddd0cc652eeb3f2322ebb6c9c1c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f16fa0d844d23e8946b0675d15c67e2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a2f16fa0d844d23e8946b0675d15c67e2">CurrentItemName</a> () const</td></tr>
|
|
<tr class="separator:a2f16fa0d844d23e8946b0675d15c67e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9e22049d6ae378344a016695d3762ca"><td class="memItemLeft" align="right" valign="top">ON__UINT64 </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#ac9e22049d6ae378344a016695d3762ca">CurrentItemSize</a> () const</td></tr>
|
|
<tr class="separator:ac9e22049d6ae378344a016695d3762ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a797cc1b6ccc3fdbd60f45c527ca94ccf"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a797cc1b6ccc3fdbd60f45c527ca94ccf">DirectoryName</a> () const</td></tr>
|
|
<tr class="separator:a797cc1b6ccc3fdbd60f45c527ca94ccf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a567cb1ab3261da62b69574d4da31910f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a567cb1ab3261da62b69574d4da31910f">FirstItem</a> ()</td></tr>
|
|
<tr class="memdesc:a567cb1ab3261da62b69574d4da31910f"><td class="mdescLeft"> </td><td class="mdescRight">Find the first matching item in the directory. <a href="#a567cb1ab3261da62b69574d4da31910f">More...</a><br /></td></tr>
|
|
<tr class="separator:a567cb1ab3261da62b69574d4da31910f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a645792dfdd91e9e6740699c3965c871c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a645792dfdd91e9e6740699c3965c871c">Initialize</a> (const wchar_t *directory_name)</td></tr>
|
|
<tr class="memdesc:a645792dfdd91e9e6740699c3965c871c"><td class="mdescLeft"> </td><td class="mdescRight">Initialize where the search should occur. <a href="#a645792dfdd91e9e6740699c3965c871c">More...</a><br /></td></tr>
|
|
<tr class="separator:a645792dfdd91e9e6740699c3965c871c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d033fd80c40858284bde98bf62302de"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a1d033fd80c40858284bde98bf62302de">Initialize</a> (const wchar_t *directory_name, const wchar_t *item_name_filter)</td></tr>
|
|
<tr class="separator:a1d033fd80c40858284bde98bf62302de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfe956c2c6d7ff8a597bf8b1ac7bbd90"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#adfe956c2c6d7ff8a597bf8b1ac7bbd90">Initialize</a> (const char *directory_name)</td></tr>
|
|
<tr class="separator:adfe956c2c6d7ff8a597bf8b1ac7bbd90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61e7a7d3f6bb7b30b10194db8f9cdf28"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a61e7a7d3f6bb7b30b10194db8f9cdf28">Initialize</a> (const char *directory_name, const char *item_name_filter)</td></tr>
|
|
<tr class="separator:a61e7a7d3f6bb7b30b10194db8f9cdf28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c555e74a6fb6206017ee15193329126"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a5c555e74a6fb6206017ee15193329126">NextItem</a> ()</td></tr>
|
|
<tr class="memdesc:a5c555e74a6fb6206017ee15193329126"><td class="mdescLeft"> </td><td class="mdescRight">Find the next matching item in the directory. <a href="#a5c555e74a6fb6206017ee15193329126">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c555e74a6fb6206017ee15193329126"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10adb7b493fac17ec843fbed88dd605b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a10adb7b493fac17ec843fbed88dd605b">Reset</a> ()</td></tr>
|
|
<tr class="memdesc:a10adb7b493fac17ec843fbed88dd605b"><td class="mdescLeft"> </td><td class="mdescRight">Reset this <a class="el" href="../../d5/db7/class_o_n___file_iterator.html" title="Iterates through every item in a file system directory. ">ON_FileIterator</a> so it can be used again. <a href="#a10adb7b493fac17ec843fbed88dd605b">More...</a><br /></td></tr>
|
|
<tr class="separator:a10adb7b493fac17ec843fbed88dd605b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Iterates through every item in a file system directory. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a3f019250af476aa9eef3f27042228238"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f019250af476aa9eef3f27042228238">◆ </a></span>ON_FileIterator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_FileIterator::ON_FileIterator </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d9be2bf6d82bf811d5b46bcc22b2d1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d9be2bf6d82bf811d5b46bcc22b2d1e">◆ </a></span>~ON_FileIterator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_FileIterator::~ON_FileIterator </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a0532d70638788a817bdbe1fbf9b8e6d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0532d70638788a817bdbe1fbf9b8e6d9">◆ </a></span>CurrentItemCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON__UINT64 ON_FileIterator::CurrentItemCount </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 matching items iterated through. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae48ad7e53caeed626d34813e572f50e0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae48ad7e53caeed626d34813e572f50e0">◆ </a></span>CurrentItemFullPathName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> ON_FileIterator::CurrentItemFullPathName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a56d27043026dacf1b76798e0e459e3f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a56d27043026dacf1b76798e0e459e3f5">◆ </a></span>CurrentItemIsDirectory()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::CurrentItemIsDirectory </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af9ea0b74070a1aaa1ae6da324d57a95a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9ea0b74070a1aaa1ae6da324d57a95a">◆ </a></span>CurrentItemIsFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::CurrentItemIsFile </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1f9e8e24468037be466501d6e199eca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1f9e8e24468037be466501d6e199eca">◆ </a></span>CurrentItemIsHidden()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::CurrentItemIsHidden </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1051ddd0cc652eeb3f2322ebb6c9c1c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1051ddd0cc652eeb3f2322ebb6c9c1c2">◆ </a></span>CurrentItemLastModifiedTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON__UINT64 ON_FileIterator::CurrentItemLastModifiedTime </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>File last modified time in seconds since January 1, 1970 </dd></dl>
|
|
<p>The times returned by <a class="el" href="../../d5/db7/class_o_n___file_iterator.html" title="Iterates through every item in a file system directory. ">ON_FileIterator</a> can differ from the time returned by <a class="el" href="../../dd/da7/class_o_n___file_stream.html#ac344f0e78881d31fe07aa99f63955700" title="Portable wrapper for C runtime fstat(). ">ON_FileStream::GetFileInformation()</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f16fa0d844d23e8946b0675d15c67e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f16fa0d844d23e8946b0675d15c67e2">◆ </a></span>CurrentItemName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> ON_FileIterator::CurrentItemName </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 file or directory name in the directory being iterated. Use CurrentFullPathItemName() to get the full path name. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9e22049d6ae378344a016695d3762ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9e22049d6ae378344a016695d3762ca">◆ </a></span>CurrentItemSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON__UINT64 ON_FileIterator::CurrentItemSize </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>If the current item is a file, then the size of the file in bytes is returned. If the current item is a directory, then 0 is returned. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a797cc1b6ccc3fdbd60f45c527ca94ccf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a797cc1b6ccc3fdbd60f45c527ca94ccf">◆ </a></span>DirectoryName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> ON_FileIterator::DirectoryName </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>The name of the directory being iterated. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a567cb1ab3261da62b69574d4da31910f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a567cb1ab3261da62b69574d4da31910f">◆ </a></span>FirstItem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::FirstItem </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find the first matching item in the directory. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true: The iterator is set to the first item. false: There are no matching items. </dd></dl>
|
|
<div class="fragment"><div class="line"> <span class="comment">// Iterate through the files in a directory named "\rootdir\subdir"</span></div><div class="line"> <a class="code" href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a> fit;</div><div class="line"> fit.<a class="code" href="../../d5/db7/class_o_n___file_iterator.html#a645792dfdd91e9e6740699c3965c871c">Initialize</a>(<span class="stringliteral">"\\rootdir\\subdir"</span>);</div><div class="line"> <span class="keywordflow">for</span> ( <span class="keywordtype">bool</span> bHaveItem = fit.<a class="code" href="../../d5/db7/class_o_n___file_iterator.html#a567cb1ab3261da62b69574d4da31910f">FirstItem</a>(); bHaveItem; bHaveItem = fit.<a class="code" href="../../d5/db7/class_o_n___file_iterator.html#a5c555e74a6fb6206017ee15193329126">NextItem</a>() )</div><div class="line"> {</div><div class="line"> <span class="keywordflow">if</span> ( fit.CurrentFileIsDirectory() )</div><div class="line"> <span class="keywordflow">continue</span>;</div><div class="line"> <a class="code" href="../../d2/d3b/class_o_n___string.html">ON_String</a> fullpath = fit.<a class="code" href="../../d5/db7/class_o_n___file_iterator.html#ae48ad7e53caeed626d34813e572f50e0">CurrentItemFullPathName</a>();</div><div class="line"> FILE* fp = <a class="code" href="../../dd/da7/class_o_n___file_stream.html#a09e4b43c9176ae7854ba10e5d21b2923">ON_FileStream::Open</a>(fullpath,<span class="stringliteral">"rb"</span>);</div><div class="line"> <span class="keywordflow">if</span> ( 0 == fp )</div><div class="line"> {</div><div class="line"> <span class="keywordflow">continue</span>;</div><div class="line"> }</div><div class="line"> ...</div><div class="line"> <a class="code" href="../../dd/da7/class_o_n___file_stream.html#a519b0b8ae279eae9834a3433c11bc54c">ON_FileStream::Close</a>(fp);</div><div class="line"> fp = 0;</div><div class="line"> }</div><div class="line">}</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a645792dfdd91e9e6740699c3965c871c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a645792dfdd91e9e6740699c3965c871c">◆ </a></span>Initialize() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::Initialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const wchar_t * </td>
|
|
<td class="paramname"><em>directory_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize where the search should occur. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">directory_name</td><td>[in] The directory to look in.</td></tr>
|
|
<tr><td class="paramname">item_name_filter</td><td>[in] If this paramter is null, then the iteration includes all names in the directory. The item name to search for. This parameter can include wildcard characters, such as an asterisk (*) or a question mark (?). For example, "\rootdir\subdir\*.*" will iterate all files in the \ directory. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><p class="startdd">true: The iterator is set to the first item. false: There are no matching items.</p>
|
|
<p class="enddd"></p>
|
|
</dd></dl>
|
|
<p>Calling <a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a567cb1ab3261da62b69574d4da31910f" title="Find the first matching item in the directory. ">FirstItem()</a> is eqivalent to calling <a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a645792dfdd91e9e6740699c3965c871c" title="Initialize where the search should occur. ">Initialize()</a> and then calling <a class="el" href="../../d5/db7/class_o_n___file_iterator.html#a5c555e74a6fb6206017ee15193329126" title="Find the next matching item in the directory. ">NextItem()</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d033fd80c40858284bde98bf62302de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d033fd80c40858284bde98bf62302de">◆ </a></span>Initialize() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::Initialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const wchar_t * </td>
|
|
<td class="paramname"><em>directory_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const wchar_t * </td>
|
|
<td class="paramname"><em>item_name_filter</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfe956c2c6d7ff8a597bf8b1ac7bbd90"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfe956c2c6d7ff8a597bf8b1ac7bbd90">◆ </a></span>Initialize() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::Initialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>directory_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a61e7a7d3f6bb7b30b10194db8f9cdf28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61e7a7d3f6bb7b30b10194db8f9cdf28">◆ </a></span>Initialize() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::Initialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>directory_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>item_name_filter</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c555e74a6fb6206017ee15193329126"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c555e74a6fb6206017ee15193329126">◆ </a></span>NextItem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_FileIterator::NextItem </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find the next matching item in the directory. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true: The iterator was advanced to the next item. false: There are no more matching items. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a10adb7b493fac17ec843fbed88dd605b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10adb7b493fac17ec843fbed88dd605b">◆ </a></span>Reset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_FileIterator::Reset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reset this <a class="el" href="../../d5/db7/class_o_n___file_iterator.html" title="Iterates through every item in a file system directory. ">ON_FileIterator</a> so it can be used again. </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: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>
|