lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-03-30 15:36:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
05ca20eaf4faacef2aba407d3d0ce037e9ed1e16
opennurbs/6/d6/da3/opennurbs__file__utilities_8h_source.html
Bozo 832ccb5c1a Publish! 
Generated from v6.0.11315.11111-test14
2018-02-03 11:08:49 -08:00

103 lines
261 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: D:/BuildAgent/work/d8e3bf9e94f4c621/src4/bin/opennurbs_public/opennurbs_file_utilities.h Source File</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_2ea30aa2956a8db99dd22aa5e597f384.html">bin</a></li><li class="navelem"><a class="el" href="../../dir_7a6cfee8d318bd47c162fe536aecd3a7.html">opennurbs_public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">opennurbs_file_utilities.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Copyright (c) 1993-2015 Robert McNeel &amp; Associates. All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// McNeel &amp; Associates.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// THIS SOFTWARE IS PROVIDED &quot;AS IS&quot; WITHOUT EXPRESS OR IMPLIED WARRANTY.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// MERCHANTABILITY ARE HEREBY DISCLAIMED.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// </span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// For complete openNURBS copyright information see &lt;http://www.opennurbs.org&gt;.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"></span>*/</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#if !defined(OPENNURBS_FILE_UTILITIES_INC_)</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define OPENNURBS_FILE_UTILITIES_INC_</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="../../db/d70/class_o_n___file_system.html"> 19</a></span>&#160;<span class="keyword">class </span>ON_CLASS <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; ~<a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>(<span class="keyword">const</span> <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> PathExists(</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* path</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; );</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> PathExists(</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; );</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"> True if path is a directory.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> False otherwise.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsDirectory(</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* path</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; );</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> True if path is a directory.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> False otherwise.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsDirectory(</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; );</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> True if path is a directory where files can be written.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> False otherwise.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsDirectoryWithWriteAccess(</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* path</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; );</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> True if path is a directory where files can be written.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"> False otherwise.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsDirectoryWithWriteAccess(</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; );</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> True if path is a file.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"> False otherwise.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsFile(</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* path</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; );</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> True if path is a file.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> False otherwise.</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsFile(</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; );</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"> Description</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"> Remove a file</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment"> file_path - [in]</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="comment"> name of file to delete</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="comment"> True if the fuke existed and was removed.</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> RemoveFile(</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* file_path</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; );</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment"> Description</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"> Remove a file</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"> file_path - [in]</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> name of file to delete</span></div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="../../d1/d6e/class_o_n___file_system_path.html"> 109</a></span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> True if the fuke existed and was removed.</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> RemoveFile(</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* file_path</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; );</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;};</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="keyword">class </span>ON_CLASS <a class="code" href="../../d1/d6e/class_o_n___file_system_path.html">ON_FileSystemPath</a></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;{</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <a class="code" href="../../d1/d6e/class_o_n___file_system_path.html">ON_FileSystemPath</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; ~<a class="code" href="../../d1/d6e/class_o_n___file_system_path.html">ON_FileSystemPath</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <a class="code" href="../../d1/d6e/class_o_n___file_system_path.html">ON_FileSystemPath</a>(<span class="keyword">const</span> <a class="code" href="../../d1/d6e/class_o_n___file_system_path.html">ON_FileSystemPath</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <a class="code" href="../../d1/d6e/class_o_n___file_system_path.html">ON_FileSystemPath</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d1/d6e/class_o_n___file_system_path.html">ON_FileSystemPath</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="../../d1/d6e/class_o_n___file_system_path.html#ab6bb6fa41402f20e8ffeec11dc5828f2"> 127</a></span>&#160;<span class="comment"> Platform dependent character used to separate directory names.</span></div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="../../d1/d6e/class_o_n___file_system_path.html#aae9819121b9ebd432e557564cbf544a6"> 128</a></span>&#160;<span class="comment"> On Windows platforms: </span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment"> ON_FileSystemPath::DirectorySeparator = ON_wString::Backslash.</span></div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="../../d1/d6e/class_o_n___file_system_path.html#a63a93220ec63160b28218856f0456433"> 130</a></span>&#160;<span class="comment"> On UNIX (including modern Apple) platforms: </span></div><div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="../../d1/d6e/class_o_n___file_system_path.html#a551e205ad74cd752b42ee99c8b3df59b"> 131</a></span>&#160;<span class="comment"> ON_FileSystemPath::DirectorySeparator = ON_wString::Slash.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> DirectorySeparatorAsChar;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">wchar_t</span> DirectorySeparator;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> AlternateDirectorySeparatorAsChar;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">wchar_t</span> AlternateDirectorySeparator;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsDirectorySeparator(</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordtype">char</span> c,</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordtype">bool</span> bAllowAlternate</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; );</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsDirectorySeparator(</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keywordtype">wchar_t</span> c,</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keywordtype">bool</span> bAllowAlternate</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; );</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="comment"> Find the locations in a path the specify the drive, directory,</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="comment"> file name and file extension.</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;<span class="comment"> path to split</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="comment"> volume - [out] (pass null if you don&#39;t need the volume)</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="comment"> If volume is not null and the path parameter begins with a</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="comment"> Windows volume specification, *volume will either be</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="comment"> the Windows volume letter followed by the trailing colon</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="comment"> or a Windows UNC \&lt;hostname&gt;. Otherwise volume will</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="comment"> be the empty string.</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="comment"> dir - [out] (pass null if you don&#39;t need the directory)</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="comment"> If dir is not null and the path parameter contains a</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;<span class="comment"> directory specification, then the returned value of *dir</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="comment"> will be the directory specification including the trailing</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;<span class="comment"> slash.</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;<span class="comment"> file_name_stem - [out] (pass null if you don&#39;t need the file name stem)</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="comment"> If file_name_stem is not null and the path parameter contains a</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;<span class="comment"> file name specification, then the returned value of *file_name_stem</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="comment"> will be the file name stem.</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;<span class="comment"> file_name_ext - [out] (pass null if you don&#39;t need the extension)</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="comment"> If file_name_ext is not null and the path parameter contains a</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="comment"> file name extension specification, then the returned value of</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="comment"> *file_name_ext will be the file name extension including the initial</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;<span class="comment"> &#39;.&#39; character.</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="comment"> This function will treat a front slash ( / ) and a back slash</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="comment"> ( \ ) as directory separators. Because this function parses</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="comment"> file names store in .3dm files and the .3dm file may have been</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<span class="comment"> written on a Windows computer and then read on a another</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;<span class="comment"> computer, it looks for a volume specification even when the</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;<span class="comment"> operating system is not Windows.</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;<span class="comment"> This function will not return an directory that does not</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;<span class="comment"> end with a trailing slash.</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;<span class="comment"> This function will not return an empty filename and a non-empty</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;<span class="comment"> extension.</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;<span class="comment"> This function parses the path string according to these rules.</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;<span class="comment"> It does not check the actual file system to see if the answer</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;<span class="comment"> is correct.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;<span class="comment"> See Also:</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;<span class="comment"> on_splitpath</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> SplitPath( </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* path,</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; <a class="code" href="../../d2/d3b/class_o_n___string.html">ON_String</a>* volume,</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <a class="code" href="../../d2/d3b/class_o_n___string.html">ON_String</a>* dir,</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <a class="code" href="../../d2/d3b/class_o_n___string.html">ON_String</a>* file_name_stem,</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <a class="code" href="../../d2/d3b/class_o_n___string.html">ON_String</a>* file_name_ext</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; );</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> SplitPath( </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* path,</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* volume,</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* dir,</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* file_name_stem,</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* file_name_ext</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; );</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> SplitPath( </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path,</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* volume,</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* dir,</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* file_name_stem,</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* file_name_ext</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; );</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> SplitPath( </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path,</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* volume,</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* dir,</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* file_name_stem_and_extension</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; );</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> FilePathHas3dmExtension(</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* file_path,</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; <span class="keywordtype">bool</span> bAllow3dmbakExtension</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; );</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> FilePathHas3dmExtension(</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* file_path,</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; <span class="keywordtype">bool</span> bAllow3dmbakExtension</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; );</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;<span class="comment"> Determine if the file_name string is a permitted file name.</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;<span class="comment"> Valid file names must be non empty, cannot have two periods in a row,</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;<span class="comment"> and cannot contain directory separators, tildes, and other </span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;<span class="comment"> platform specific values.</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;<span class="comment"> file_name - [in]</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;<span class="comment"> string to test.</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;<span class="comment"> bAllPlatforms - [in]</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;<span class="comment"> If true, test name for all supported platforms.</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;<span class="comment"> True if the string can be a file name.</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsValidFileName(</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* file_name,</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; <span class="keywordtype">bool</span> bAllPlatforms</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; );</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;<span class="comment"> Determine if the file_name string is a permitted file name.</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;<span class="comment"> Valid file names must be non empty, cannot have two periods in a row,</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;<span class="comment"> and cannot contain directory separators, tildes, and other </span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;<span class="comment"> platform specific values.</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;<span class="comment"> file_name - [in]</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;<span class="comment"> string to test.</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;<span class="comment"> bAllPlatforms - [in]</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<span class="comment"> If true, test name for all supported platforms.</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;<span class="comment"> True if the string can be a file name.</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsValidFileName(</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* file_name,</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; <span class="keywordtype">bool</span> bAllPlatforms</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160; );</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160;<span class="comment"> path to split</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;<span class="comment"> The volume portion of the path. </span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> VolumeFromPath(</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160; );</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;<span class="comment"> path to split</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;<span class="comment"> The directory portion of the path. </span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> DirectoryFromPath(</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; );</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160;<span class="comment"> path to split</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;<span class="comment"> The volume and directory portion of the path. </span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> VolumeAndDirectoryFromPath(</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160; );</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;<span class="comment"> path to split</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;<span class="comment"> bIncludeExtension - [in]</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;<span class="comment"> The file name portion of the path. </span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> FileNameFromPath(</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path,</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; <span class="keywordtype">bool</span> bIncludeExtension</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; );</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160;</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;<span class="comment"> path to split</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160;<span class="comment"> The file name extension portion of the path, inlcuding the leading period or &quot;dot&quot;.</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> FileNameExtensionFromPath(</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; );</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160;<span class="comment"> Condenses // to /</span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160;<span class="comment"> Condenses /./ to /</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160;<span class="comment"> Condenses /sfsdf/../ to /</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;<span class="comment"> Sets all directory separators to directory_separator.</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;<span class="comment"> bAllowWindowsUNCHostNameOrDiskLetter - [in]</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;<span class="comment"> If bAllowWindowsUNCHostNameOrDiskLetter and the path begins with \\HostName followed by</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160;<span class="comment"> a directory separator, then the initial \\ is not condensed. </span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160;<span class="comment"> If the path begins with X: followed by a directory separator, where &quot;X&quot; is a single</span></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160;<span class="comment"> letter in the range A to Z or a to z, then the path is considered valid.</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160;<span class="comment"> bDeleteWindowsUNCHostNameOrDiskLetter - [in]</span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;<span class="comment"> If bAllowWindowsUNCHostNameOrDiskLetter is true and the path begins with a UNC</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;<span class="comment"> host name or disk letter followed by a directory separator, then host name or disk letter</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;<span class="comment"> is deleted. This is useful when using paths from a Windows platform on a</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160;<span class="comment"> non-Windows platform.</span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;<span class="comment"> directory_separator - [in]</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;<span class="comment"> If 0 == directory_separator, then the first directory separator</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160;<span class="comment"> is kept when condensing occurs.</span></div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;<span class="comment"> ON_wString::FileSystemPathSeparator is a good choice if you want</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;<span class="comment"> to use the current runtime&#39;s separator.</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;<span class="comment"> dirty_path - [in]</span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;<span class="comment"> path to clean.</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;<span class="comment"> Return:</span></div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;<span class="comment"> Cleaned path.</span></div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> CleanPath(</div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160; <span class="keywordtype">bool</span> bTrimLeft,</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160; <span class="keywordtype">bool</span> bTrimRight,</div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160; <span class="keywordtype">bool</span> bAllowWindowsUNCHostNameOrDiskLetter,</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160; <span class="keywordtype">bool</span> bDeleteWindowsUNCHostNameOrDiskLetter,</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span> directory_separator,</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* dirty_path</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160; );</div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160;</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;<span class="comment"> path to test</span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160;<span class="comment"> directory_separator - [in]</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160;<span class="comment"> If 0 == directory_separator, then either ON_wString::FileSystemPathSeparator </span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160;<span class="comment"> or ON_wString::AlternateFileSystemPathSeparator is permitted as a directory</span></div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160;<span class="comment"> separator.</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160;<span class="comment"> ON_wString::FileSystemPathSeparator is a good choice if you want</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160;<span class="comment"> to use the current runtime&#39;s separator.</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160;<span class="comment"> True if path begins with ../ or ./</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsRelativePath(</div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path,</div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span> directory_separator</div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160; );</div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160;</div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160;</div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160;<span class="comment"> path to test</span></div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160;<span class="comment"> True if path begins with ../ or ..\ or ./ or .\</span></div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> IsRelativePath(</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160; );</div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160;<span class="comment"> Condenses // to /</span></div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160;<span class="comment"> Condenses /./ to /</span></div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160;<span class="comment"> Condenses /sfsdf/../ to /</span></div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160;<span class="comment"> Trims left and right white space.</span></div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;<span class="comment"> Sets all directory separators to ON_FileSystemPath::DirectorySeparator.</span></div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160;<span class="comment"> If the Platform is not windows, the UNC host names and volume letters are deleted.</span></div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> CleanPath(</div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* dirty_path</div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160; );</div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160; </div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;<span class="comment"> Get a the relative path from base_path to full_path.</span></div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160;<span class="comment"> full_path - [in]</span></div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160;<span class="comment"> base_path - [in]</span></div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160;<span class="comment"> Example</span></div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160;<span class="comment"> full_path = L&quot;c:/a/b/c/d/somefile.txt&quot;;</span></div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160;<span class="comment"> base_path = L&quot;C:/A/B/X/Y/Z/model.3dm&quot;;</span></div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160;<span class="comment"> ON_wString::GetRelativePath(full_path,base_path) returns</span></div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160;<span class="comment"> L&quot;../../../c/d/somefile.txt&quot;</span></div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160;<span class="comment"> Example</span></div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;<span class="comment"> full_path = L&quot;c:/a/b/somefile.txt&quot;;</span></div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160;<span class="comment"> base_path = L&quot;C:/A/B/model.3dm&quot;;</span></div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;<span class="comment"> ON_wString::GetRelativePath(full_path,base_path) returns</span></div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160;<span class="comment"> L&quot;./somefile.txt&quot;</span></div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160;<span class="comment"> Path separators on the input can be mixed.</span></div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160;<span class="comment"> Path separators on the returned relative path are ON_wString::FileSystemPathSeparator</span></div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> RelativePath(</div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* full_path,</div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160; <span class="keywordtype">bool</span> bFullPathIncludesFileName,</div><div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName</div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160; );</div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160;</div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> FullPathFromRelativePath(</div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName,</div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* relative_path</div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160; );</div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160;</div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160;<span class="comment"> true if the platform file system ignores case.</span></div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160;<span class="comment"> Windows and default installations of OS X 10.10.3, and default installations of the UNIX </span></div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160;<span class="comment"> terminal interface in OS X 10.10.3 and later ignore case.</span></div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160;<span class="comment"> In the case of OX X, a user can override the default setting.</span></div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> PlatformPathIgnoreCase();</div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span>&#160;</div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span>&#160;<span class="comment"> bWithTrailingDirectorySeparator - [in]</span></div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span>&#160;<span class="comment"> true - returned path will have a trailing directory separator.</span></div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span>&#160;<span class="comment"> false - returned path will not have a trailing directory separator.</span></div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span>&#160;<span class="comment"> The platform current working directory which should be the directory</span></div><div class="line"><a name="l00460"></a><span class="lineno"> 460</span>&#160;<span class="comment"> where ON::OpenFile(&quot;fname&quot;,&quot;r&quot;) would look for a file named &quot;fname&quot;.</span></div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00462"></a><span class="lineno"> 462</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> CurrentDirectory(</div><div class="line"><a name="l00463"></a><span class="lineno"> 463</span>&#160; <span class="keywordtype">bool</span> bWithTrailingDirectorySeparator</div><div class="line"><a name="l00464"></a><span class="lineno"> 464</span>&#160; );</div><div class="line"><a name="l00465"></a><span class="lineno"> 465</span>&#160;</div><div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00467"></a><span class="lineno"> 467</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00468"></a><span class="lineno"> 468</span>&#160;<span class="comment"> Removes file name from path.</span></div><div class="line"><a name="l00469"></a><span class="lineno"> 469</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00470"></a><span class="lineno"> 470</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00471"></a><span class="lineno"> 471</span>&#160;<span class="comment"> file system path with a file name.</span></div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span>&#160;<span class="comment"> file_name - [out]</span></div><div class="line"><a name="l00473"></a><span class="lineno"> 473</span>&#160;<span class="comment"> If file_name is not nullptr, the removed portion of path</span></div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span>&#160;<span class="comment"> is returned here.</span></div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span>&#160;<span class="comment"> path with any file name removed.</span></div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span>&#160;<span class="comment"> This function uses on_wsplitpath() to decide if the path ends with characters that</span></div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span>&#160;<span class="comment"> could be a file name. It does not inspect the file system to see if the file exists.</span></div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> RemoveFileName(</div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path,</div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* file_name</div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span>&#160; );</div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span>&#160;</div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span>&#160;<span class="comment"> Removes Windows volume name from path.</span></div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span>&#160;<span class="comment"> path - [in]</span></div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span>&#160;<span class="comment"> file system path</span></div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span>&#160;<span class="comment"> volume_name - [out]</span></div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span>&#160;<span class="comment"> If volume_name is not nullptr, the removed portion of path</span></div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span>&#160;<span class="comment"> is returned here.</span></div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span>&#160;<span class="comment"> path with any volume name removed.</span></div><div class="line"><a name="l00497"></a><span class="lineno"> 497</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span>&#160;<span class="comment"> This function uses on_wsplitpath() to decide if the path begins with characters that</span></div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span>&#160;<span class="comment"> could be a volume name. It does not inspect the file system to see if the volume exists.</span></div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> RemoveVolumeName(</div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* path,</div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>* volume_name</div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span>&#160; );</div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span>&#160;</div><div class="line"><a name="l00506"></a><span class="lineno"> 506</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>&#160;<span class="comment"> Combine paths into a single valid path name. Remove internal .. and . </span></div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span>&#160;<span class="comment"> directory references. If necessary remove file names.</span></div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00511"></a><span class="lineno"><a class="line" href="../../d1/d6e/class_o_n___file_system_path.html#ae6a9483116ab6d025cfdf11161e19485"> 511</a></span>&#160;<span class="comment"> left_side - [in]</span></div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span>&#160;<span class="comment"> bLeftSideContainsFileName - [in]</span></div><div class="line"><a name="l00513"></a><span class="lineno"> 513</span>&#160;<span class="comment"> true if left_side path ends in a file name and that</span></div><div class="line"><a name="l00514"></a><span class="lineno"> 514</span>&#160;<span class="comment"> file name is removed and discarded.</span></div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span>&#160;<span class="comment"> right_side - [in]</span></div><div class="line"><a name="l00516"></a><span class="lineno"> 516</span>&#160;<span class="comment"> bRightSideContainsFileName - [in]</span></div><div class="line"><a name="l00517"></a><span class="lineno"> 517</span>&#160;<span class="comment"> true if right_side path ends in a file name.</span></div><div class="line"><a name="l00518"></a><span class="lineno"> 518</span>&#160;<span class="comment"> If bAppendTrailingDirectorySeparator is true, that file name is removed</span></div><div class="line"><a name="l00519"></a><span class="lineno"> 519</span>&#160;<span class="comment"> and discarded. If bAppendTrailingDirectorySeparator is false, the</span></div><div class="line"><a name="l00520"></a><span class="lineno"> 520</span>&#160;<span class="comment"> returned path ends in that file name.</span></div><div class="line"><a name="l00521"></a><span class="lineno"> 521</span>&#160;<span class="comment"> bAppendTrailingDirectorySeparator - [in]</span></div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span>&#160;<span class="comment"> If true, any file names are removed and a directory separator</span></div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span>&#160;<span class="comment"> is appended to the returned string.</span></div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span>&#160;<span class="comment"> a path made left_side + right_side</span></div><div class="line"><a name="l00526"></a><span class="lineno"> 526</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00527"></a><span class="lineno"> 527</span>&#160;<span class="comment"> This function manipulates string information. </span></div><div class="line"><a name="l00528"></a><span class="lineno"> 528</span>&#160;<span class="comment"> This function does not look at storage media</span></div><div class="line"><a name="l00529"></a><span class="lineno"> 529</span>&#160;<span class="comment"> to see if the paths currently exist.</span></div><div class="line"><a name="l00530"></a><span class="lineno"> 530</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00531"></a><span class="lineno"> 531</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> CombinePaths(</div><div class="line"><a name="l00532"></a><span class="lineno"> 532</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* left_side,</div><div class="line"><a name="l00533"></a><span class="lineno"> 533</span>&#160; <span class="keywordtype">bool</span> bLeftSideContainsFileName,</div><div class="line"><a name="l00534"></a><span class="lineno"> 534</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* right_side,</div><div class="line"><a name="l00535"></a><span class="lineno"> 535</span>&#160; <span class="keywordtype">bool</span> bRightSideContainsFileName,</div><div class="line"><a name="l00536"></a><span class="lineno"> 536</span>&#160; <span class="keywordtype">bool</span> bAppendTrailingDirectorySeparator</div><div class="line"><a name="l00537"></a><span class="lineno"> 537</span>&#160; );</div><div class="line"><a name="l00538"></a><span class="lineno"> 538</span>&#160;</div><div class="line"><a name="l00539"></a><span class="lineno"> 539</span>&#160; <span class="comment">// ids used by ON_FileSystemPath::GetPath()</span></div><div class="line"><a name="l00540"></a><span class="lineno"> 540</span>&#160; <span class="keyword">enum class</span> <a class="code" href="../../d1/d6e/class_o_n___file_system_path.html#ae6a9483116ab6d025cfdf11161e19485">PathId</a> : unsigned int</div><div class="line"><a name="l00541"></a><span class="lineno"> 541</span>&#160; {</div><div class="line"><a name="l00542"></a><span class="lineno"> 542</span>&#160; Unset = 0,</div><div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160; DesktopDirectory = 1,</div><div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160; DocumentsDirectory = 2,</div><div class="line"><a name="l00545"></a><span class="lineno"> 545</span>&#160; DownloadsDirectory = 3</div><div class="line"><a name="l00546"></a><span class="lineno"> 546</span>&#160; };</div><div class="line"><a name="l00547"></a><span class="lineno"> 547</span>&#160;</div><div class="line"><a name="l00548"></a><span class="lineno"> 548</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00549"></a><span class="lineno"> 549</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160;<span class="comment"> path_id - [in]</span></div><div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160;<span class="comment"> Specifies path to get.</span></div><div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160;<span class="comment"> Requested path. If the path does not exist in the current context, </span></div><div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160;<span class="comment"> the empty string is returned.</span></div><div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00556"></a><span class="lineno"> 556</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> PlatformPath(</div><div class="line"><a name="l00557"></a><span class="lineno"> 557</span>&#160; <a class="code" href="../../d1/d6e/class_o_n___file_system_path.html#ae6a9483116ab6d025cfdf11161e19485">ON_FileSystemPath::PathId</a> path_id</div><div class="line"><a name="l00558"></a><span class="lineno"> 558</span>&#160; );</div><div class="line"><a name="l00559"></a><span class="lineno"> 559</span>&#160;</div><div class="line"><a name="l00560"></a><span class="lineno"> 560</span>&#160;</div><div class="line"><a name="l00561"></a><span class="lineno"><a class="line" href="../../dd/da7/class_o_n___file_stream.html"> 561</a></span>&#160; ON_DEPRECATED_MSG(<span class="stringliteral">&quot;Use ON_FileSystem::PathExists&quot;</span>)</div><div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160; static <span class="keywordtype">bool</span> PathExists(</div><div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160; const <span class="keywordtype">char</span>* path</div><div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160; );</div><div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160;</div><div class="line"><a name="l00566"></a><span class="lineno"> 566</span>&#160; ON_DEPRECATED_MSG(&quot;Use <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>::PathExists&quot;)</div><div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160; static <span class="keywordtype">bool</span> PathExists(</div><div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160; const <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160; );</div><div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160;</div><div class="line"><a name="l00571"></a><span class="lineno"> 571</span>&#160; ON_DEPRECATED_MSG(&quot;Use <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>::IsDirectory&quot;)</div><div class="line"><a name="l00572"></a><span class="lineno"> 572</span>&#160; static <span class="keywordtype">bool</span> IsDirectory(</div><div class="line"><a name="l00573"></a><span class="lineno"> 573</span>&#160; const <span class="keywordtype">char</span>* path</div><div class="line"><a name="l00574"></a><span class="lineno"> 574</span>&#160; );</div><div class="line"><a name="l00575"></a><span class="lineno"> 575</span>&#160;</div><div class="line"><a name="l00576"></a><span class="lineno"> 576</span>&#160; ON_DEPRECATED_MSG(&quot;Use <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>::IsDirectory&quot;)</div><div class="line"><a name="l00577"></a><span class="lineno"> 577</span>&#160; static <span class="keywordtype">bool</span> IsDirectory(</div><div class="line"><a name="l00578"></a><span class="lineno"> 578</span>&#160; const <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00579"></a><span class="lineno"> 579</span>&#160; );</div><div class="line"><a name="l00580"></a><span class="lineno"> 580</span>&#160;</div><div class="line"><a name="l00581"></a><span class="lineno"> 581</span>&#160; ON_DEPRECATED_MSG(&quot;Use <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>::IsFile&quot;)</div><div class="line"><a name="l00582"></a><span class="lineno"> 582</span>&#160; static <span class="keywordtype">bool</span> IsFile(</div><div class="line"><a name="l00583"></a><span class="lineno"> 583</span>&#160; const <span class="keywordtype">char</span>* path</div><div class="line"><a name="l00584"></a><span class="lineno"> 584</span>&#160; );</div><div class="line"><a name="l00585"></a><span class="lineno"> 585</span>&#160;</div><div class="line"><a name="l00586"></a><span class="lineno"> 586</span>&#160; ON_DEPRECATED_MSG(&quot;Use <a class="code" href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a>::IsFile&quot;)</div><div class="line"><a name="l00587"></a><span class="lineno"> 587</span>&#160; static <span class="keywordtype">bool</span> IsFile(</div><div class="line"><a name="l00588"></a><span class="lineno"> 588</span>&#160; const <span class="keywordtype">wchar_t</span>* path</div><div class="line"><a name="l00589"></a><span class="lineno"> 589</span>&#160; );</div><div class="line"><a name="l00590"></a><span class="lineno"> 590</span>&#160;};</div><div class="line"><a name="l00591"></a><span class="lineno"> 591</span>&#160;</div><div class="line"><a name="l00592"></a><span class="lineno"> 592</span>&#160;class ON_CLASS <a class="code" href="../../dd/da7/class_o_n___file_stream.html">ON_FileStream</a></div><div class="line"><a name="l00593"></a><span class="lineno"> 593</span>&#160;{</div><div class="line"><a name="l00594"></a><span class="lineno"> 594</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00595"></a><span class="lineno"> 595</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00596"></a><span class="lineno"> 596</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00597"></a><span class="lineno"> 597</span>&#160;<span class="comment"> Portable wrapper for C runtime fopen().</span></div><div class="line"><a name="l00598"></a><span class="lineno"> 598</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00599"></a><span class="lineno"> 599</span>&#160;<span class="comment"> filename - [in]</span></div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span>&#160;<span class="comment"> mode - [in]</span></div><div class="line"><a name="l00601"></a><span class="lineno"> 601</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00602"></a><span class="lineno"> 602</span>&#160;<span class="comment"> Use the ON_FileStream static functions for reading, writing, </span></div><div class="line"><a name="l00603"></a><span class="lineno"> 603</span>&#160;<span class="comment"> seeking, position finding with the FILE pointer returned</span></div><div class="line"><a name="l00604"></a><span class="lineno"> 604</span>&#160;<span class="comment"> by this function.</span></div><div class="line"><a name="l00605"></a><span class="lineno"> 605</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00606"></a><span class="lineno"> 606</span>&#160; <span class="keyword">static</span> FILE* Open( <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* filename, <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* mode );</div><div class="line"><a name="l00607"></a><span class="lineno"> 607</span>&#160;</div><div class="line"><a name="l00608"></a><span class="lineno"> 608</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00609"></a><span class="lineno"> 609</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00610"></a><span class="lineno"> 610</span>&#160;<span class="comment"> Portable wrapper for C runtime fopen().</span></div><div class="line"><a name="l00611"></a><span class="lineno"> 611</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00612"></a><span class="lineno"> 612</span>&#160;<span class="comment"> filename - [in]</span></div><div class="line"><a name="l00613"></a><span class="lineno"> 613</span>&#160;<span class="comment"> mode - [in]</span></div><div class="line"><a name="l00614"></a><span class="lineno"> 614</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00615"></a><span class="lineno"> 615</span>&#160;<span class="comment"> Use the ON_FileStream static functions for reading, writing, </span></div><div class="line"><a name="l00616"></a><span class="lineno"> 616</span>&#160;<span class="comment"> seeking, position finding with the FILE pointer returned</span></div><div class="line"><a name="l00617"></a><span class="lineno"> 617</span>&#160;<span class="comment"> by this function.</span></div><div class="line"><a name="l00618"></a><span class="lineno"> 618</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00619"></a><span class="lineno"> 619</span>&#160; <span class="keyword">static</span> FILE* Open( <span class="keyword">const</span> <span class="keywordtype">char</span>* filename, <span class="keyword">const</span> <span class="keywordtype">char</span>* mode );</div><div class="line"><a name="l00620"></a><span class="lineno"> 620</span>&#160;</div><div class="line"><a name="l00621"></a><span class="lineno"> 621</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00622"></a><span class="lineno"> 622</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00623"></a><span class="lineno"> 623</span>&#160;<span class="comment"> Portable wrapper for C runtime fclose().</span></div><div class="line"><a name="l00624"></a><span class="lineno"> 624</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00625"></a><span class="lineno"> 625</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00626"></a><span class="lineno"> 626</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open().</span></div><div class="line"><a name="l00627"></a><span class="lineno"> 627</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00628"></a><span class="lineno"> 628</span>&#160;<span class="comment"> 0: successful</span></div><div class="line"><a name="l00629"></a><span class="lineno"> 629</span>&#160;<span class="comment"> -1: null fp parameter</span></div><div class="line"><a name="l00630"></a><span class="lineno"> 630</span>&#160;<span class="comment"> != 0: fclose() failure code</span></div><div class="line"><a name="l00631"></a><span class="lineno"> 631</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00632"></a><span class="lineno"> 632</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> Close( FILE* fp );</div><div class="line"><a name="l00633"></a><span class="lineno"> 633</span>&#160;</div><div class="line"><a name="l00634"></a><span class="lineno"> 634</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00635"></a><span class="lineno"> 635</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00636"></a><span class="lineno"> 636</span>&#160;<span class="comment"> True if the file is a 3dm archive.</span></div><div class="line"><a name="l00637"></a><span class="lineno"> 637</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00638"></a><span class="lineno"> 638</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> Is3dmFile(</div><div class="line"><a name="l00639"></a><span class="lineno"> 639</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* file_path,</div><div class="line"><a name="l00640"></a><span class="lineno"> 640</span>&#160; <span class="keywordtype">bool</span> bAllow3dmbakExtension</div><div class="line"><a name="l00641"></a><span class="lineno"> 641</span>&#160; );</div><div class="line"><a name="l00642"></a><span class="lineno"> 642</span>&#160;</div><div class="line"><a name="l00643"></a><span class="lineno"> 643</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00644"></a><span class="lineno"> 644</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00645"></a><span class="lineno"> 645</span>&#160;<span class="comment"> True if the file is a 3dm archive.</span></div><div class="line"><a name="l00646"></a><span class="lineno"> 646</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00647"></a><span class="lineno"> 647</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> Is3dmFile(</div><div class="line"><a name="l00648"></a><span class="lineno"> 648</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* file_path,</div><div class="line"><a name="l00649"></a><span class="lineno"> 649</span>&#160; <span class="keywordtype">bool</span> bAllow3dmbakExtension</div><div class="line"><a name="l00650"></a><span class="lineno"> 650</span>&#160; );</div><div class="line"><a name="l00651"></a><span class="lineno"> 651</span>&#160;</div><div class="line"><a name="l00652"></a><span class="lineno"> 652</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00653"></a><span class="lineno"> 653</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00654"></a><span class="lineno"> 654</span>&#160;<span class="comment"> Open the file and seek to the location where the 3dm archive information begins.</span></div><div class="line"><a name="l00655"></a><span class="lineno"> 655</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00656"></a><span class="lineno"> 656</span>&#160;<span class="comment"> A file stream with the current position at the beginning of the 3dm archive.</span></div><div class="line"><a name="l00657"></a><span class="lineno"> 657</span>&#160;<span class="comment"> nullptr if the file is not a 3dm archive.</span></div><div class="line"><a name="l00658"></a><span class="lineno"> 658</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00659"></a><span class="lineno"> 659</span>&#160; <span class="keyword">static</span> FILE* Open3dmToRead(</div><div class="line"><a name="l00660"></a><span class="lineno"> 660</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* file_path</div><div class="line"><a name="l00661"></a><span class="lineno"> 661</span>&#160; );</div><div class="line"><a name="l00662"></a><span class="lineno"> 662</span>&#160;</div><div class="line"><a name="l00663"></a><span class="lineno"> 663</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00664"></a><span class="lineno"> 664</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00665"></a><span class="lineno"> 665</span>&#160;<span class="comment"> Open the file and seek to the location where the 3dm archive information begins.</span></div><div class="line"><a name="l00666"></a><span class="lineno"> 666</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00667"></a><span class="lineno"> 667</span>&#160;<span class="comment"> A file stream with the current position at the beginning of the 3dm archive.</span></div><div class="line"><a name="l00668"></a><span class="lineno"> 668</span>&#160;<span class="comment"> nullptr if the file is not a 3dm archive.</span></div><div class="line"><a name="l00669"></a><span class="lineno"> 669</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00670"></a><span class="lineno"> 670</span>&#160; <span class="keyword">static</span> FILE* Open3dmToRead(</div><div class="line"><a name="l00671"></a><span class="lineno"> 671</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* file_path</div><div class="line"><a name="l00672"></a><span class="lineno"> 672</span>&#160; );</div><div class="line"><a name="l00673"></a><span class="lineno"> 673</span>&#160; </div><div class="line"><a name="l00674"></a><span class="lineno"> 674</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00675"></a><span class="lineno"> 675</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00676"></a><span class="lineno"> 676</span>&#160;<span class="comment"> Portable wrapper for C runtime ftell().</span></div><div class="line"><a name="l00677"></a><span class="lineno"> 677</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00678"></a><span class="lineno"> 678</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00679"></a><span class="lineno"> 679</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open().</span></div><div class="line"><a name="l00680"></a><span class="lineno"> 680</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00681"></a><span class="lineno"> 681</span>&#160;<span class="comment"> &gt;= 0: current file position</span></div><div class="line"><a name="l00682"></a><span class="lineno"> 682</span>&#160;<span class="comment"> -1: an error occured</span></div><div class="line"><a name="l00683"></a><span class="lineno"> 683</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00684"></a><span class="lineno"> 684</span>&#160; <span class="keyword">static</span> ON__INT64 CurrentPosition( FILE* fp );</div><div class="line"><a name="l00685"></a><span class="lineno"> 685</span>&#160;</div><div class="line"><a name="l00686"></a><span class="lineno"> 686</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00687"></a><span class="lineno"> 687</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00688"></a><span class="lineno"> 688</span>&#160;<span class="comment"> Portable wrapper for C runtime fseek(fp,offset,SEEK_CUR).</span></div><div class="line"><a name="l00689"></a><span class="lineno"> 689</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00690"></a><span class="lineno"> 690</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00691"></a><span class="lineno"> 691</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open().</span></div><div class="line"><a name="l00692"></a><span class="lineno"> 692</span>&#160;<span class="comment"> offset - [in]</span></div><div class="line"><a name="l00693"></a><span class="lineno"> 693</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00694"></a><span class="lineno"> 694</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> SeekFromCurrentPosition( FILE* fp, ON__INT64 offset );</div><div class="line"><a name="l00695"></a><span class="lineno"> 695</span>&#160;</div><div class="line"><a name="l00696"></a><span class="lineno"> 696</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00697"></a><span class="lineno"> 697</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00698"></a><span class="lineno"> 698</span>&#160;<span class="comment"> Portable wrapper for C runtime fseek(fp,offset,SEEK_SET).</span></div><div class="line"><a name="l00699"></a><span class="lineno"> 699</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00700"></a><span class="lineno"> 700</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00701"></a><span class="lineno"> 701</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open().</span></div><div class="line"><a name="l00702"></a><span class="lineno"> 702</span>&#160;<span class="comment"> offset - [in]</span></div><div class="line"><a name="l00703"></a><span class="lineno"> 703</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00704"></a><span class="lineno"> 704</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> SeekFromStart( FILE* fp, ON__INT64 offset );</div><div class="line"><a name="l00705"></a><span class="lineno"> 705</span>&#160;</div><div class="line"><a name="l00706"></a><span class="lineno"> 706</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00707"></a><span class="lineno"> 707</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00708"></a><span class="lineno"> 708</span>&#160;<span class="comment"> Portable wrapper for C runtime fseek(fp,offset,SEEK_END).</span></div><div class="line"><a name="l00709"></a><span class="lineno"> 709</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00710"></a><span class="lineno"> 710</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00711"></a><span class="lineno"> 711</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open().</span></div><div class="line"><a name="l00712"></a><span class="lineno"> 712</span>&#160;<span class="comment"> offset - [in]</span></div><div class="line"><a name="l00713"></a><span class="lineno"> 713</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00714"></a><span class="lineno"> 714</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> SeekFromEnd( FILE* fp, ON__INT64 offset );</div><div class="line"><a name="l00715"></a><span class="lineno"> 715</span>&#160;</div><div class="line"><a name="l00716"></a><span class="lineno"> 716</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00717"></a><span class="lineno"> 717</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00718"></a><span class="lineno"> 718</span>&#160;<span class="comment"> Portable wrapper for C runtime fseek(fp,offset,origin).</span></div><div class="line"><a name="l00719"></a><span class="lineno"> 719</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00720"></a><span class="lineno"> 720</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00721"></a><span class="lineno"> 721</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open().</span></div><div class="line"><a name="l00722"></a><span class="lineno"> 722</span>&#160;<span class="comment"> offset - [in]</span></div><div class="line"><a name="l00723"></a><span class="lineno"> 723</span>&#160;<span class="comment"> origin - [in]</span></div><div class="line"><a name="l00724"></a><span class="lineno"> 724</span>&#160;<span class="comment"> SEEK_SET (0): seek from beginning of file. </span></div><div class="line"><a name="l00725"></a><span class="lineno"> 725</span>&#160;<span class="comment"> SEEK_CUR (1): seek from current position of file pointer.</span></div><div class="line"><a name="l00726"></a><span class="lineno"> 726</span>&#160;<span class="comment"> SEEK_END (2): seek from end of file.</span></div><div class="line"><a name="l00727"></a><span class="lineno"> 727</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00728"></a><span class="lineno"> 728</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> Seek( FILE* fp, ON__INT64 offset, <span class="keywordtype">int</span> orgin );</div><div class="line"><a name="l00729"></a><span class="lineno"> 729</span>&#160;</div><div class="line"><a name="l00730"></a><span class="lineno"> 730</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00731"></a><span class="lineno"> 731</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00732"></a><span class="lineno"> 732</span>&#160;<span class="comment"> Portable wrapper for C runtime fread(buffer,1,count,fp).</span></div><div class="line"><a name="l00733"></a><span class="lineno"> 733</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00734"></a><span class="lineno"> 734</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00735"></a><span class="lineno"> 735</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open()</span></div><div class="line"><a name="l00736"></a><span class="lineno"> 736</span>&#160;<span class="comment"> count - [in]</span></div><div class="line"><a name="l00737"></a><span class="lineno"> 737</span>&#160;<span class="comment"> number of bytes to read.</span></div><div class="line"><a name="l00738"></a><span class="lineno"> 738</span>&#160;<span class="comment"> buffer - [out]</span></div><div class="line"><a name="l00739"></a><span class="lineno"> 739</span>&#160;<span class="comment"> read bytes are stored in this buffer</span></div><div class="line"><a name="l00740"></a><span class="lineno"> 740</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00741"></a><span class="lineno"> 741</span>&#160;<span class="comment"> number of bytes read</span></div><div class="line"><a name="l00742"></a><span class="lineno"> 742</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00743"></a><span class="lineno"> 743</span>&#160; <span class="keyword">static</span> ON__UINT64 Read( FILE* fp, ON__UINT64 count, <span class="keywordtype">void</span>* buffer );</div><div class="line"><a name="l00744"></a><span class="lineno"> 744</span>&#160;</div><div class="line"><a name="l00745"></a><span class="lineno"> 745</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00746"></a><span class="lineno"> 746</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00747"></a><span class="lineno"> 747</span>&#160;<span class="comment"> Portable wrapper for C runtime fwrite(buffer,1,count,fp).</span></div><div class="line"><a name="l00748"></a><span class="lineno"> 748</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00749"></a><span class="lineno"> 749</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00750"></a><span class="lineno"> 750</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open()</span></div><div class="line"><a name="l00751"></a><span class="lineno"> 751</span>&#160;<span class="comment"> count - [in]</span></div><div class="line"><a name="l00752"></a><span class="lineno"> 752</span>&#160;<span class="comment"> number of bytes to write</span></div><div class="line"><a name="l00753"></a><span class="lineno"> 753</span>&#160;<span class="comment"> buffer - [in]</span></div><div class="line"><a name="l00754"></a><span class="lineno"> 754</span>&#160;<span class="comment"> data to be written</span></div><div class="line"><a name="l00755"></a><span class="lineno"> 755</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00756"></a><span class="lineno"> 756</span>&#160;<span class="comment"> number of bytes written.</span></div><div class="line"><a name="l00757"></a><span class="lineno"> 757</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00758"></a><span class="lineno"> 758</span>&#160; <span class="keyword">static</span> ON__UINT64 Write( FILE* fp, ON__UINT64 count, <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer );</div><div class="line"><a name="l00759"></a><span class="lineno"> 759</span>&#160;</div><div class="line"><a name="l00760"></a><span class="lineno"> 760</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00761"></a><span class="lineno"> 761</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00762"></a><span class="lineno"><a class="line" href="../../db/d13/class_o_n___content_hash.html"> 762</a></span>&#160;<span class="comment"> Portable wrapper for C runtime fflush(fp).</span></div><div class="line"><a name="l00763"></a><span class="lineno"> 763</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00764"></a><span class="lineno"> 764</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00765"></a><span class="lineno"><a class="line" href="../../db/d13/class_o_n___content_hash.html#ab9616094ebaee5e3d8e0b68aa8e459be"> 765</a></span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open().</span></div><div class="line"><a name="l00766"></a><span class="lineno"> 766</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00767"></a><span class="lineno"> 767</span>&#160;<span class="comment"> true if flush was successful. False if an error occured.</span></div><div class="line"><a name="l00768"></a><span class="lineno"> 768</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00769"></a><span class="lineno"> 769</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> Flush( FILE* fp );</div><div class="line"><a name="l00770"></a><span class="lineno"> 770</span>&#160;</div><div class="line"><a name="l00771"></a><span class="lineno"> 771</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00772"></a><span class="lineno"> 772</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00773"></a><span class="lineno"> 773</span>&#160;<span class="comment"> Portable wrapper for C runtime fstat().</span></div><div class="line"><a name="l00774"></a><span class="lineno"> 774</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00775"></a><span class="lineno"> 775</span>&#160;<span class="comment"> fp - [in]</span></div><div class="line"><a name="l00776"></a><span class="lineno"> 776</span>&#160;<span class="comment"> FILE pointer returned by ON_FileStream::Open().</span></div><div class="line"><a name="l00777"></a><span class="lineno"> 777</span>&#160;<span class="comment"> file_size - [out]</span></div><div class="line"><a name="l00778"></a><span class="lineno"> 778</span>&#160;<span class="comment"> If file_size is not null, the the size of the file</span></div><div class="line"><a name="l00779"></a><span class="lineno"> 779</span>&#160;<span class="comment"> in bytes returned here</span></div><div class="line"><a name="l00780"></a><span class="lineno"> 780</span>&#160;<span class="comment"> file_metadata_last_modified_time - [out]</span></div><div class="line"><a name="l00781"></a><span class="lineno"> 781</span>&#160;<span class="comment"> If file_metadata_last_modified_time is not null, then the time the </span></div><div class="line"><a name="l00782"></a><span class="lineno"> 782</span>&#160;<span class="comment"> file&#39;s metadata (owner, permissions, ...) were last modified is returned</span></div><div class="line"><a name="l00783"></a><span class="lineno"> 783</span>&#160;<span class="comment"> here as the number of seconds since midnight January 1, 1970.</span></div><div class="line"><a name="l00784"></a><span class="lineno"> 784</span>&#160;<span class="comment"> file_contents_last_modified_time - [out]</span></div><div class="line"><a name="l00785"></a><span class="lineno"> 785</span>&#160;<span class="comment"> If file_contents_last_modified_time is not null, then the time the </span></div><div class="line"><a name="l00786"></a><span class="lineno"> 786</span>&#160;<span class="comment"> file&#39;s contents were last modified is returned here as the number of</span></div><div class="line"><a name="l00787"></a><span class="lineno"> 787</span>&#160;<span class="comment"> seconds since midnight January 1, 1970.</span></div><div class="line"><a name="l00788"></a><span class="lineno"> 788</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00789"></a><span class="lineno"> 789</span>&#160;<span class="comment"> true if the query was successful. False if an error occured.</span></div><div class="line"><a name="l00790"></a><span class="lineno"> 790</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00791"></a><span class="lineno"> 791</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> GetFileInformation( </div><div class="line"><a name="l00792"></a><span class="lineno"> 792</span>&#160; FILE* fp,</div><div class="line"><a name="l00793"></a><span class="lineno"> 793</span>&#160; ON__UINT64* file_size,</div><div class="line"><a name="l00794"></a><span class="lineno"> 794</span>&#160; ON__UINT64* file_metadata_last_modified_time,</div><div class="line"><a name="l00795"></a><span class="lineno"> 795</span>&#160; ON__UINT64* file_contents_last_modified_time</div><div class="line"><a name="l00796"></a><span class="lineno"> 796</span>&#160; );</div><div class="line"><a name="l00797"></a><span class="lineno"> 797</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> GetFileInformation( </div><div class="line"><a name="l00798"></a><span class="lineno"> 798</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* file_name,</div><div class="line"><a name="l00799"></a><span class="lineno"> 799</span>&#160; ON__UINT64* file_size,</div><div class="line"><a name="l00800"></a><span class="lineno"> 800</span>&#160; ON__UINT64* file_metadata_last_modified_time,</div><div class="line"><a name="l00801"></a><span class="lineno"> 801</span>&#160; ON__UINT64* file_contents_last_modified_time</div><div class="line"><a name="l00802"></a><span class="lineno"> 802</span>&#160; );</div><div class="line"><a name="l00803"></a><span class="lineno"> 803</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> GetFileInformation( </div><div class="line"><a name="l00804"></a><span class="lineno"> 804</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* file_name,</div><div class="line"><a name="l00805"></a><span class="lineno"> 805</span>&#160; ON__UINT64* file_size,</div><div class="line"><a name="l00806"></a><span class="lineno"> 806</span>&#160; ON__UINT64* file_metadata_last_modified_time,</div><div class="line"><a name="l00807"></a><span class="lineno"> 807</span>&#160; ON__UINT64* file_contents_last_modified_time</div><div class="line"><a name="l00808"></a><span class="lineno"> 808</span>&#160; );</div><div class="line"><a name="l00809"></a><span class="lineno"> 809</span>&#160;};</div><div class="line"><a name="l00810"></a><span class="lineno"> 810</span>&#160;</div><div class="line"><a name="l00811"></a><span class="lineno"> 811</span>&#160;<span class="keyword">class </span>ON_CLASS <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a></div><div class="line"><a name="l00812"></a><span class="lineno"> 812</span>&#160;{</div><div class="line"><a name="l00813"></a><span class="lineno"> 813</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00814"></a><span class="lineno"> 814</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> Unset;</div><div class="line"><a name="l00815"></a><span class="lineno"> 815</span>&#160;</div><div class="line"><a name="l00816"></a><span class="lineno"> 816</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00817"></a><span class="lineno"> 817</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00818"></a><span class="lineno"> 818</span>&#160; ~<a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00819"></a><span class="lineno"> 819</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>(<span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00820"></a><span class="lineno"> 820</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00821"></a><span class="lineno"> 821</span>&#160;</div><div class="line"><a name="l00822"></a><span class="lineno"> 822</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00823"></a><span class="lineno"> 823</span>&#160;<span class="comment"> Descripton:</span></div><div class="line"><a name="l00824"></a><span class="lineno"> 824</span>&#160;<span class="comment"> Create an ON_ContentHash class with the specified size, hash and times.</span></div><div class="line"><a name="l00825"></a><span class="lineno"> 825</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00826"></a><span class="lineno"> 826</span>&#160;<span class="comment"> sha1_name_hash - [in]</span></div><div class="line"><a name="l00827"></a><span class="lineno"> 827</span>&#160;<span class="comment"> The SHA-1 hash of the name (typically a full path file name).</span></div><div class="line"><a name="l00828"></a><span class="lineno"> 828</span>&#160;<span class="comment"> When the content is identified by a file name in a file system,</span></div><div class="line"><a name="l00829"></a><span class="lineno"> 829</span>&#160;<span class="comment"> use ON_SHA1_Hash::FileSystemPathHash() to calculate this value.</span></div><div class="line"><a name="l00830"></a><span class="lineno"> 830</span>&#160;<span class="comment"> byte_count - [in] </span></div><div class="line"><a name="l00831"></a><span class="lineno"> 831</span>&#160;<span class="comment"> number of bytes in the content.</span></div><div class="line"><a name="l00832"></a><span class="lineno"> 832</span>&#160;<span class="comment"> sha1_content_hash - [in]</span></div><div class="line"><a name="l00833"></a><span class="lineno"> 833</span>&#160;<span class="comment"> The SHA-1 hash of the content (typically a buffer or file).</span></div><div class="line"><a name="l00834"></a><span class="lineno"> 834</span>&#160;<span class="comment"> You may use ON_SHA1_Has::FileContentHash() or ON_SHA1_Hash::BufferContentHash()</span></div><div class="line"><a name="l00835"></a><span class="lineno"> 835</span>&#160;<span class="comment"> to calculate this value.</span></div><div class="line"><a name="l00836"></a><span class="lineno"> 836</span>&#160;<span class="comment"> hash_time - [in]</span></div><div class="line"><a name="l00837"></a><span class="lineno"> 837</span>&#160;<span class="comment"> The time the sha1_hash was calculated in seconds since January 1, 1970 UCT.</span></div><div class="line"><a name="l00838"></a><span class="lineno"> 838</span>&#160;<span class="comment"> If 0 is passed in, the current time is used.</span></div><div class="line"><a name="l00839"></a><span class="lineno"> 839</span>&#160;<span class="comment"> content_last_modified_time - [in]</span></div><div class="line"><a name="l00840"></a><span class="lineno"> 840</span>&#160;<span class="comment"> Pass 0 if not known.</span></div><div class="line"><a name="l00841"></a><span class="lineno"> 841</span>&#160;<span class="comment"> The time the hashed information that was last modifed in seconds since January 1, 1970 UCT.</span></div><div class="line"><a name="l00842"></a><span class="lineno"> 842</span>&#160;<span class="comment"> If content_last_modified_time &gt; hash_time, then 0 is used.</span></div><div class="line"><a name="l00843"></a><span class="lineno"> 843</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00844"></a><span class="lineno"> 844</span>&#160;<span class="comment"> An ON_ContentHash with size and SHA-1 hash and times set from the parameters,</span></div><div class="line"><a name="l00845"></a><span class="lineno"> 845</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00846"></a><span class="lineno"> 846</span>&#160; <span class="keyword">static</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> Create(</div><div class="line"><a name="l00847"></a><span class="lineno"> 847</span>&#160; <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> sha1_name_hash,</div><div class="line"><a name="l00848"></a><span class="lineno"> 848</span>&#160; ON__UINT64 byte_count,</div><div class="line"><a name="l00849"></a><span class="lineno"> 849</span>&#160; <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> sha1_content_hash,</div><div class="line"><a name="l00850"></a><span class="lineno"> 850</span>&#160; ON__UINT64 hash_time,</div><div class="line"><a name="l00851"></a><span class="lineno"> 851</span>&#160; ON__UINT64 content_last_modified_time</div><div class="line"><a name="l00852"></a><span class="lineno"> 852</span>&#160; );</div><div class="line"><a name="l00853"></a><span class="lineno"> 853</span>&#160;</div><div class="line"><a name="l00854"></a><span class="lineno"> 854</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00855"></a><span class="lineno"> 855</span>&#160;<span class="comment"> Descripton:</span></div><div class="line"><a name="l00856"></a><span class="lineno"> 856</span>&#160;<span class="comment"> Create an ON_ContentHash from a memory buffer.</span></div><div class="line"><a name="l00857"></a><span class="lineno"> 857</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00858"></a><span class="lineno"> 858</span>&#160;<span class="comment"> sha1_name_hash - [in]</span></div><div class="line"><a name="l00859"></a><span class="lineno"> 859</span>&#160;<span class="comment"> A SHA-1 hash of the name associated with this content.</span></div><div class="line"><a name="l00860"></a><span class="lineno"> 860</span>&#160;<span class="comment"> If the buffer has no name, pass ON_SHA1_Hash::ZeroDigest.</span></div><div class="line"><a name="l00861"></a><span class="lineno"> 861</span>&#160;<span class="comment"> If the buffer has an empty name, pass ON_SHA1_Hash::EmptyContentHash.</span></div><div class="line"><a name="l00862"></a><span class="lineno"> 862</span>&#160;<span class="comment"> buffer - [in] </span></div><div class="line"><a name="l00863"></a><span class="lineno"> 863</span>&#160;<span class="comment"> byte_count - [in] </span></div><div class="line"><a name="l00864"></a><span class="lineno"> 864</span>&#160;<span class="comment"> number of bytes in buffer[]</span></div><div class="line"><a name="l00865"></a><span class="lineno"> 865</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00866"></a><span class="lineno"> 866</span>&#160;<span class="comment"> An ON_ContentHash with size and SHA-1 hash calculated from the parameters,</span></div><div class="line"><a name="l00867"></a><span class="lineno"> 867</span>&#160;<span class="comment"> hash time = now, and content last modified time = 0.</span></div><div class="line"><a name="l00868"></a><span class="lineno"> 868</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00869"></a><span class="lineno"> 869</span>&#160; <span class="keyword">static</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> CreateFromBuffer( </div><div class="line"><a name="l00870"></a><span class="lineno"> 870</span>&#160; <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> sha1_name_hash,</div><div class="line"><a name="l00871"></a><span class="lineno"> 871</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer,</div><div class="line"><a name="l00872"></a><span class="lineno"> 872</span>&#160; <span class="keywordtype">size_t</span> byte_count</div><div class="line"><a name="l00873"></a><span class="lineno"> 873</span>&#160; );</div><div class="line"><a name="l00874"></a><span class="lineno"> 874</span>&#160;</div><div class="line"><a name="l00875"></a><span class="lineno"> 875</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00876"></a><span class="lineno"> 876</span>&#160;<span class="comment"> Descripton:</span></div><div class="line"><a name="l00877"></a><span class="lineno"> 877</span>&#160;<span class="comment"> Create an ON_ContentHash from a file stream.</span></div><div class="line"><a name="l00878"></a><span class="lineno"> 878</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00879"></a><span class="lineno"> 879</span>&#160;<span class="comment"> sha1_file_name_hash - [in]</span></div><div class="line"><a name="l00880"></a><span class="lineno"> 880</span>&#160;<span class="comment"> A SHA-1 hash of the file name associated with fp.</span></div><div class="line"><a name="l00881"></a><span class="lineno"> 881</span>&#160;<span class="comment"> Use ON_SHA1_Has::FileSystemPathHash() to create the value.</span></div><div class="line"><a name="l00882"></a><span class="lineno"> 882</span>&#160;<span class="comment"> If the name is not known, pass ON_SHA1_Hash::ZeroDigest.</span></div><div class="line"><a name="l00883"></a><span class="lineno"> 883</span>&#160;<span class="comment"> fp - [in] pointer to a file opened with ON:FileOpen(...,&quot;rb&quot;)</span></div><div class="line"><a name="l00884"></a><span class="lineno"> 884</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00885"></a><span class="lineno"> 885</span>&#160;<span class="comment"> An ON_ContentHash with size and SHA-1 hash and times set from the file,</span></div><div class="line"><a name="l00886"></a><span class="lineno"> 886</span>&#160;<span class="comment"> hash time = now, and content last modifed time set from the file system</span></div><div class="line"><a name="l00887"></a><span class="lineno"> 887</span>&#160;<span class="comment"> information returned by ON_FileStream::GetFileInformation().</span></div><div class="line"><a name="l00888"></a><span class="lineno"> 888</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00889"></a><span class="lineno"> 889</span>&#160; <span class="keyword">static</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> CreateFromFile( </div><div class="line"><a name="l00890"></a><span class="lineno"> 890</span>&#160; <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> sha1_file_name_hash,</div><div class="line"><a name="l00891"></a><span class="lineno"> 891</span>&#160; FILE* fp</div><div class="line"><a name="l00892"></a><span class="lineno"> 892</span>&#160; );</div><div class="line"><a name="l00893"></a><span class="lineno"> 893</span>&#160;</div><div class="line"><a name="l00894"></a><span class="lineno"> 894</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00895"></a><span class="lineno"> 895</span>&#160;<span class="comment"> Descripton:</span></div><div class="line"><a name="l00896"></a><span class="lineno"> 896</span>&#160;<span class="comment"> Create an ON_ContentHash from a file stream.</span></div><div class="line"><a name="l00897"></a><span class="lineno"> 897</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00898"></a><span class="lineno"> 898</span>&#160;<span class="comment"> filename - [in] name of file.</span></div><div class="line"><a name="l00899"></a><span class="lineno"> 899</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00900"></a><span class="lineno"> 900</span>&#160;<span class="comment"> An ON_ContentHash with size and SHA-1 hash and times set from the file,</span></div><div class="line"><a name="l00901"></a><span class="lineno"> 901</span>&#160;<span class="comment"> hash time = now, and content last modifed time set from the file system</span></div><div class="line"><a name="l00902"></a><span class="lineno"> 902</span>&#160;<span class="comment"> information returned by ON_FileStream::GetFileInformation().</span></div><div class="line"><a name="l00903"></a><span class="lineno"> 903</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00904"></a><span class="lineno"> 904</span>&#160; <span class="keyword">static</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> CreateFromFile( </div><div class="line"><a name="l00905"></a><span class="lineno"> 905</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* filename</div><div class="line"><a name="l00906"></a><span class="lineno"> 906</span>&#160; );</div><div class="line"><a name="l00907"></a><span class="lineno"> 907</span>&#160;</div><div class="line"><a name="l00908"></a><span class="lineno"> 908</span>&#160; <span class="keyword">static</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> CreateFromFile( </div><div class="line"><a name="l00909"></a><span class="lineno"> 909</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* filename</div><div class="line"><a name="l00910"></a><span class="lineno"> 910</span>&#160; );</div><div class="line"><a name="l00911"></a><span class="lineno"> 911</span>&#160;</div><div class="line"><a name="l00912"></a><span class="lineno"> 912</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00913"></a><span class="lineno"> 913</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00914"></a><span class="lineno"> 914</span>&#160;<span class="comment"> True if the SHA-1 hash has been set.</span></div><div class="line"><a name="l00915"></a><span class="lineno"> 915</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00916"></a><span class="lineno"> 916</span>&#160; <span class="keywordtype">bool</span> IsSet() <span class="keyword">const</span>;</div><div class="line"><a name="l00917"></a><span class="lineno"> 917</span>&#160;</div><div class="line"><a name="l00918"></a><span class="lineno"> 918</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00919"></a><span class="lineno"> 919</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00920"></a><span class="lineno"> 920</span>&#160;<span class="comment"> True if the SHA-1 hash is not set.</span></div><div class="line"><a name="l00921"></a><span class="lineno"> 921</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00922"></a><span class="lineno"> 922</span>&#160; <span class="keywordtype">bool</span> IsNotSet() <span class="keyword">const</span>;</div><div class="line"><a name="l00923"></a><span class="lineno"> 923</span>&#160;</div><div class="line"><a name="l00924"></a><span class="lineno"> 924</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00925"></a><span class="lineno"> 925</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00926"></a><span class="lineno"> 926</span>&#160;<span class="comment"> Number of bytes in the content (typically a file or buffer).</span></div><div class="line"><a name="l00927"></a><span class="lineno"> 927</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00928"></a><span class="lineno"> 928</span>&#160; ON__UINT64 ByteCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00929"></a><span class="lineno"> 929</span>&#160;</div><div class="line"><a name="l00930"></a><span class="lineno"> 930</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00931"></a><span class="lineno"> 931</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00932"></a><span class="lineno"> 932</span>&#160;<span class="comment"> Time the hash SHA-1 hash was cacluated in seconds since January 1, 1970 UCT.</span></div><div class="line"><a name="l00933"></a><span class="lineno"> 933</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00934"></a><span class="lineno"> 934</span>&#160; ON__UINT64 HashCalculationTime() <span class="keyword">const</span>;</div><div class="line"><a name="l00935"></a><span class="lineno"> 935</span>&#160;</div><div class="line"><a name="l00936"></a><span class="lineno"> 936</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00937"></a><span class="lineno"> 937</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00938"></a><span class="lineno"> 938</span>&#160;<span class="comment"> Time the hashed content was last modifed in seconds since January 1, 1970 UCT.</span></div><div class="line"><a name="l00939"></a><span class="lineno"> 939</span>&#160;<span class="comment"> 0 is returned if this time is not known.</span></div><div class="line"><a name="l00940"></a><span class="lineno"> 940</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00941"></a><span class="lineno"> 941</span>&#160;<span class="comment"> This time should be used for important decisions as a last resort.</span></div><div class="line"><a name="l00942"></a><span class="lineno"> 942</span>&#160;<span class="comment"> </span></div><div class="line"><a name="l00943"></a><span class="lineno"> 943</span>&#160;<span class="comment"> When hash values differ, this time may be considered to</span></div><div class="line"><a name="l00944"></a><span class="lineno"> 944</span>&#160;<span class="comment"> which content is newer (or most recently copied). </span></div><div class="line"><a name="l00945"></a><span class="lineno"> 945</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00946"></a><span class="lineno"> 946</span>&#160;<span class="comment"> Unfortunately, in many cases this time is often unknown and incorrectly set.</span></div><div class="line"><a name="l00947"></a><span class="lineno"> 947</span>&#160;<span class="comment"> For example, some file systems set the last modified time of a copy of </span></div><div class="line"><a name="l00948"></a><span class="lineno"> 948</span>&#160;<span class="comment"> an &quot;old&quot; file to the time the copy was created. Thus a copy of &quot;old&quot; content </span></div><div class="line"><a name="l00949"></a><span class="lineno"> 949</span>&#160;<span class="comment"> may appear to be newer than &quot;new&quot; content that has not been copied. </span></div><div class="line"><a name="l00950"></a><span class="lineno"> 950</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00951"></a><span class="lineno"> 951</span>&#160; ON__UINT64 ContentLastModifiedTime() <span class="keyword">const</span>;</div><div class="line"><a name="l00952"></a><span class="lineno"> 952</span>&#160;</div><div class="line"><a name="l00953"></a><span class="lineno"> 953</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00954"></a><span class="lineno"> 954</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00955"></a><span class="lineno"> 955</span>&#160;<span class="comment"> SHA-1 hash of the name (typically a full path file name).</span></div><div class="line"><a name="l00956"></a><span class="lineno"> 956</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00957"></a><span class="lineno"> 957</span>&#160; <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> NameHash() <span class="keyword">const</span>;</div><div class="line"><a name="l00958"></a><span class="lineno"> 958</span>&#160;</div><div class="line"><a name="l00959"></a><span class="lineno"> 959</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00960"></a><span class="lineno"><a class="line" href="../../db/d13/class_o_n___content_hash.html#a5a6e077d6893727a93e91d3f1c9e847d"> 960</a></span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00961"></a><span class="lineno"> 961</span>&#160;<span class="comment"> SHA-1 hash of the content (typically a buffer or file).</span></div><div class="line"><a name="l00962"></a><span class="lineno"> 962</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00963"></a><span class="lineno"> 963</span>&#160; <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> ContentHash() <span class="keyword">const</span>;</div><div class="line"><a name="l00964"></a><span class="lineno"> 964</span>&#160; </div><div class="line"><a name="l00965"></a><span class="lineno"> 965</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00966"></a><span class="lineno"> 966</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00967"></a><span class="lineno"> 967</span>&#160;<span class="comment"> Test a buffer to see if it has a matching size and SHA-1 hash.</span></div><div class="line"><a name="l00968"></a><span class="lineno"> 968</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00969"></a><span class="lineno"> 969</span>&#160;<span class="comment"> buffer - [in] </span></div><div class="line"><a name="l00970"></a><span class="lineno"> 970</span>&#160;<span class="comment"> byte_count - [in] </span></div><div class="line"><a name="l00971"></a><span class="lineno"> 971</span>&#160;<span class="comment"> number of bytes in buffer[]</span></div><div class="line"><a name="l00972"></a><span class="lineno"> 972</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00973"></a><span class="lineno"> 973</span>&#160;<span class="comment"> True if the buffer has a matching byte_count and SHA-1 hash.</span></div><div class="line"><a name="l00974"></a><span class="lineno"> 974</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00975"></a><span class="lineno"> 975</span>&#160; <span class="keywordtype">bool</span> IsSameBufferContent( </div><div class="line"><a name="l00976"></a><span class="lineno"> 976</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer,</div><div class="line"><a name="l00977"></a><span class="lineno"> 977</span>&#160; <span class="keywordtype">size_t</span> byte_count</div><div class="line"><a name="l00978"></a><span class="lineno"> 978</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l00979"></a><span class="lineno"> 979</span>&#160;</div><div class="line"><a name="l00980"></a><span class="lineno"> 980</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00981"></a><span class="lineno"> 981</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00982"></a><span class="lineno"> 982</span>&#160;<span class="comment"> Test a file to see if it has a matching size and SHA-1 hash.</span></div><div class="line"><a name="l00983"></a><span class="lineno"> 983</span>&#160;<span class="comment"> Paramters:</span></div><div class="line"><a name="l00984"></a><span class="lineno"> 984</span>&#160;<span class="comment"> fp - [in] pointer to file opened with ON::OpenFile(...,&quot;rb&quot;)</span></div><div class="line"><a name="l00985"></a><span class="lineno"> 985</span>&#160;<span class="comment"> bSkipTimeCheck - [in] if true, the time of last</span></div><div class="line"><a name="l00986"></a><span class="lineno"> 986</span>&#160;<span class="comment"> modification is not checked.</span></div><div class="line"><a name="l00987"></a><span class="lineno"> 987</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00988"></a><span class="lineno"> 988</span>&#160;<span class="comment"> True if the file existes, can be read, and has a matching byte_count</span></div><div class="line"><a name="l00989"></a><span class="lineno"> 989</span>&#160;<span class="comment"> and SHA-1 hash.</span></div><div class="line"><a name="l00990"></a><span class="lineno"> 990</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00991"></a><span class="lineno"> 991</span>&#160; <span class="keywordtype">bool</span> IsSameFileContent( </div><div class="line"><a name="l00992"></a><span class="lineno"> 992</span>&#160; FILE* fp</div><div class="line"><a name="l00993"></a><span class="lineno"> 993</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l00994"></a><span class="lineno"> 994</span>&#160;</div><div class="line"><a name="l00995"></a><span class="lineno"> 995</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00996"></a><span class="lineno"> 996</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00997"></a><span class="lineno"> 997</span>&#160;<span class="comment"> Test a file to see if it has a matching size and SHA-1 content hash.</span></div><div class="line"><a name="l00998"></a><span class="lineno"> 998</span>&#160;<span class="comment"> Paramters:</span></div><div class="line"><a name="l00999"></a><span class="lineno"> 999</span>&#160;<span class="comment"> filename - [in]</span></div><div class="line"><a name="l01000"></a><span class="lineno"> 1000</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01001"></a><span class="lineno"> 1001</span>&#160;<span class="comment"> True if the file exists, can be read, and has a matching byte_count</span></div><div class="line"><a name="l01002"></a><span class="lineno"> 1002</span>&#160;<span class="comment"> and SHA-1 content hash.</span></div><div class="line"><a name="l01003"></a><span class="lineno"> 1003</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01004"></a><span class="lineno"> 1004</span>&#160; <span class="keywordtype">bool</span> IsSameFileContent( </div><div class="line"><a name="l01005"></a><span class="lineno"> 1005</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* filename</div><div class="line"><a name="l01006"></a><span class="lineno"> 1006</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01007"></a><span class="lineno"> 1007</span>&#160;</div><div class="line"><a name="l01008"></a><span class="lineno"> 1008</span>&#160; <span class="keywordtype">bool</span> IsSameFileContent( </div><div class="line"><a name="l01009"></a><span class="lineno"> 1009</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* filename</div><div class="line"><a name="l01010"></a><span class="lineno"> 1010</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01011"></a><span class="lineno"> 1011</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01012"></a><span class="lineno"> 1012</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01013"></a><span class="lineno"> 1013</span>&#160;<span class="comment"> /// ON_ContentHash::Compare are the possible results of calling ON_ContentHash::CompareFile().</span></div><div class="line"><a name="l01014"></a><span class="lineno"> 1014</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01015"></a><span class="lineno"> 1015</span>&#160;<span class="comment"></span> <span class="keyword">enum class</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html#a5a6e077d6893727a93e91d3f1c9e847d">CompareResult</a> : unsigned char</div><div class="line"><a name="l01016"></a><span class="lineno"> 1016</span>&#160; {<span class="comment"></span></div><div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>&#160;<span class="comment"> /// Not set. This value is never returned by ON_ContentHash::CheckFile().</span></div><div class="line"><a name="l01019"></a><span class="lineno"> 1019</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01020"></a><span class="lineno"> 1020</span>&#160;<span class="comment"></span> Unset = 0,</div><div class="line"><a name="l01021"></a><span class="lineno"> 1021</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01022"></a><span class="lineno"> 1022</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01023"></a><span class="lineno"> 1023</span>&#160;<span class="comment"> /// File exists and its size and content matches the information </span></div><div class="line"><a name="l01024"></a><span class="lineno"> 1024</span>&#160;<span class="comment"> /// used to set the content hash.</span></div><div class="line"><a name="l01025"></a><span class="lineno"> 1025</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01026"></a><span class="lineno"> 1026</span>&#160;<span class="comment"></span> EqualContent = 1,</div><div class="line"><a name="l01027"></a><span class="lineno"> 1027</span>&#160; <span class="comment"></span></div><div class="line"><a name="l01028"></a><span class="lineno"> 1028</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01029"></a><span class="lineno"> 1029</span>&#160;<span class="comment"> /// File exists and its size or content differs from the information </span></div><div class="line"><a name="l01030"></a><span class="lineno"> 1030</span>&#160;<span class="comment"> /// used to set the content hash. Unable to reliably determine which</span></div><div class="line"><a name="l01031"></a><span class="lineno"> 1031</span>&#160;<span class="comment"> /// is newer.</span></div><div class="line"><a name="l01032"></a><span class="lineno"> 1032</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01033"></a><span class="lineno"> 1033</span>&#160;<span class="comment"></span> DifferentContent = 2, </div><div class="line"><a name="l01034"></a><span class="lineno"> 1034</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01035"></a><span class="lineno"> 1035</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01036"></a><span class="lineno"> 1036</span>&#160;<span class="comment"> /// File exists and its size or content differs from the information </span></div><div class="line"><a name="l01037"></a><span class="lineno"> 1037</span>&#160;<span class="comment"> /// used to set the content hash. The file&#39;s laste modified time</span></div><div class="line"><a name="l01038"></a><span class="lineno"> 1038</span>&#160;<span class="comment"> /// is older than ContentLastModifiedTime().</span></div><div class="line"><a name="l01039"></a><span class="lineno"> 1039</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01040"></a><span class="lineno"> 1040</span>&#160;<span class="comment"></span> DifferentContentFileIsOlder = 3,</div><div class="line"><a name="l01041"></a><span class="lineno"> 1041</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01042"></a><span class="lineno"> 1042</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01043"></a><span class="lineno"> 1043</span>&#160;<span class="comment"> /// File exists and its size or content differs from the information </span></div><div class="line"><a name="l01044"></a><span class="lineno"> 1044</span>&#160;<span class="comment"> /// used to set the content hash. The file&#39;s last modified time</span></div><div class="line"><a name="l01045"></a><span class="lineno"> 1045</span>&#160;<span class="comment"> /// is newer than ContentLastModifiedTime().</span></div><div class="line"><a name="l01046"></a><span class="lineno"> 1046</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01047"></a><span class="lineno"> 1047</span>&#160;<span class="comment"></span> ContentDifferentFileIsNewer = 4,</div><div class="line"><a name="l01048"></a><span class="lineno"> 1048</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01049"></a><span class="lineno"> 1049</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01050"></a><span class="lineno"> 1050</span>&#160;<span class="comment"> /// File does not exist.</span></div><div class="line"><a name="l01051"></a><span class="lineno"> 1051</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01052"></a><span class="lineno"> 1052</span>&#160;<span class="comment"></span> FileDoesNotExist = 5,</div><div class="line"><a name="l01053"></a><span class="lineno"> 1053</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01054"></a><span class="lineno"> 1054</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01055"></a><span class="lineno"> 1055</span>&#160;<span class="comment"> /// File cannot be opened, read, or some other file system issue prevents checking.</span></div><div class="line"><a name="l01056"></a><span class="lineno"> 1056</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01057"></a><span class="lineno"> 1057</span>&#160;<span class="comment"></span> FileSystemFailure = 6</div><div class="line"><a name="l01058"></a><span class="lineno"> 1058</span>&#160; };</div><div class="line"><a name="l01059"></a><span class="lineno"> 1059</span>&#160;</div><div class="line"><a name="l01060"></a><span class="lineno"> 1060</span>&#160; <span class="keyword">static</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html#a5a6e077d6893727a93e91d3f1c9e847d">ON_ContentHash::CompareResult</a> CompareResultFromUnsigned(</div><div class="line"><a name="l01061"></a><span class="lineno"> 1061</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> compare_result_as_unsigned</div><div class="line"><a name="l01062"></a><span class="lineno"> 1062</span>&#160; );</div><div class="line"><a name="l01063"></a><span class="lineno"> 1063</span>&#160;</div><div class="line"><a name="l01064"></a><span class="lineno"> 1064</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01065"></a><span class="lineno"> 1065</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01066"></a><span class="lineno"> 1066</span>&#160;<span class="comment"> Compare the information used to set this content hash with </span></div><div class="line"><a name="l01067"></a><span class="lineno"> 1067</span>&#160;<span class="comment"> the contents of the file.</span></div><div class="line"><a name="l01068"></a><span class="lineno"> 1068</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01069"></a><span class="lineno"> 1069</span>&#160;<span class="comment"> file_path - [in]</span></div><div class="line"><a name="l01070"></a><span class="lineno"> 1070</span>&#160;<span class="comment"> bFastCompare - [in]</span></div><div class="line"><a name="l01071"></a><span class="lineno"> 1071</span>&#160;<span class="comment"> If bFastCompare is true and the file_path, create time, last modified time, and size</span></div><div class="line"><a name="l01072"></a><span class="lineno"> 1072</span>&#160;<span class="comment"> exactly match the values in ON_ContentHash, then</span></div><div class="line"><a name="l01073"></a><span class="lineno"> 1073</span>&#160;<span class="comment"> ON_ContentHash::CompareResult::EqualContent is returned</span></div><div class="line"><a name="l01074"></a><span class="lineno"> 1074</span>&#160;<span class="comment"> without performing the expensive SHA1 test on the file&#39;s content.</span></div><div class="line"><a name="l01075"></a><span class="lineno"> 1075</span>&#160;<span class="comment"> If bFastCompare is false, the SHA-1 hash of the file&#39;s content will be </span></div><div class="line"><a name="l01076"></a><span class="lineno"> 1076</span>&#160;<span class="comment"> calculated and compared before ON_ContentHash::CompareResult::EqualContent</span></div><div class="line"><a name="l01077"></a><span class="lineno"> 1077</span>&#160;<span class="comment"> is returned.</span></div><div class="line"><a name="l01078"></a><span class="lineno"> 1078</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01079"></a><span class="lineno"> 1079</span>&#160;<span class="comment"> Result of compare test as a ON_ContentHash::CompareResult enum.</span></div><div class="line"><a name="l01080"></a><span class="lineno"> 1080</span>&#160;<span class="comment"> ON_ContentHash::CompareResult::DifferentContentFileIsOlder means file_path content is different and older than &quot;this&quot;.</span></div><div class="line"><a name="l01081"></a><span class="lineno"> 1081</span>&#160;<span class="comment"> ON_ContentHash::CompareResult::DifferentContentFileIsNewer means file_path content is different and newer than &quot;this&quot;.</span></div><div class="line"><a name="l01082"></a><span class="lineno"> 1082</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01083"></a><span class="lineno"> 1083</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html#a5a6e077d6893727a93e91d3f1c9e847d">ON_ContentHash::CompareResult</a> Compare(</div><div class="line"><a name="l01084"></a><span class="lineno"> 1084</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* file_path,</div><div class="line"><a name="l01085"></a><span class="lineno"> 1085</span>&#160; <span class="keywordtype">bool</span> bFastTest</div><div class="line"><a name="l01086"></a><span class="lineno"> 1086</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01087"></a><span class="lineno"> 1087</span>&#160;</div><div class="line"><a name="l01088"></a><span class="lineno"> 1088</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01089"></a><span class="lineno"> 1089</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01090"></a><span class="lineno"> 1090</span>&#160;<span class="comment"> Compare the byte count and SHA-1 content hash.</span></div><div class="line"><a name="l01091"></a><span class="lineno"> 1091</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01092"></a><span class="lineno"> 1092</span>&#160;<span class="comment"> file_content_hash - [in]</span></div><div class="line"><a name="l01093"></a><span class="lineno"> 1093</span>&#160;<span class="comment"> ON_ContentHash to compare against this one.</span></div><div class="line"><a name="l01094"></a><span class="lineno"> 1094</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01095"></a><span class="lineno"> 1095</span>&#160;<span class="comment"> Result of compare test as a ON_ContentHash::CompareResult enum.</span></div><div class="line"><a name="l01096"></a><span class="lineno"> 1096</span>&#160;<span class="comment"> ON_ContentHash::CompareResult::DifferentContentFileIsOlder means file_content_hash is different and older than &quot;this&quot;.</span></div><div class="line"><a name="l01097"></a><span class="lineno"> 1097</span>&#160;<span class="comment"> ON_ContentHash::CompareResult::DifferentContentFileIsNewer means file_content_hash is different and newer than &quot;this&quot;.</span></div><div class="line"><a name="l01098"></a><span class="lineno"> 1098</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01099"></a><span class="lineno"> 1099</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html#a5a6e077d6893727a93e91d3f1c9e847d">ON_ContentHash::CompareResult</a> Compare(</div><div class="line"><a name="l01100"></a><span class="lineno"> 1100</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> file_content_hash</div><div class="line"><a name="l01101"></a><span class="lineno"> 1101</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01102"></a><span class="lineno"> 1102</span>&#160;</div><div class="line"><a name="l01103"></a><span class="lineno"> 1103</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01104"></a><span class="lineno"> 1104</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01105"></a><span class="lineno"> 1105</span>&#160;<span class="comment"> true if a and b have identical ByteCount() and SHA-1 content hash values.</span></div><div class="line"><a name="l01106"></a><span class="lineno"> 1106</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01107"></a><span class="lineno"> 1107</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> EqualContent(</div><div class="line"><a name="l01108"></a><span class="lineno"> 1108</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; a,</div><div class="line"><a name="l01109"></a><span class="lineno"> 1109</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; b</div><div class="line"><a name="l01110"></a><span class="lineno"> 1110</span>&#160; );</div><div class="line"><a name="l01111"></a><span class="lineno"> 1111</span>&#160;</div><div class="line"><a name="l01112"></a><span class="lineno"> 1112</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01113"></a><span class="lineno"> 1113</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01114"></a><span class="lineno"> 1114</span>&#160;<span class="comment"> true if a and b have differnt ByteCount() or SHA-1 content hash values.</span></div><div class="line"><a name="l01115"></a><span class="lineno"> 1115</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01116"></a><span class="lineno"> 1116</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> DifferentContent(</div><div class="line"><a name="l01117"></a><span class="lineno"> 1117</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; a,</div><div class="line"><a name="l01118"></a><span class="lineno"> 1118</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; b</div><div class="line"><a name="l01119"></a><span class="lineno"> 1119</span>&#160; );</div><div class="line"><a name="l01120"></a><span class="lineno"> 1120</span>&#160;</div><div class="line"><a name="l01121"></a><span class="lineno"> 1121</span>&#160;</div><div class="line"><a name="l01122"></a><span class="lineno"> 1122</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01123"></a><span class="lineno"> 1123</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01124"></a><span class="lineno"> 1124</span>&#160;<span class="comment"> Compares content byte count and content SHA-1</span></div><div class="line"><a name="l01125"></a><span class="lineno"><a class="line" href="../../d8/dfd/class_o_n___file_reference.html"> 1125</a></span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01126"></a><span class="lineno"> 1126</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> CompareContent(</div><div class="line"><a name="l01127"></a><span class="lineno"> 1127</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; a,</div><div class="line"><a name="l01128"></a><span class="lineno"><a class="line" href="../../d8/dfd/class_o_n___file_reference.html#a06f1799b2ed593bd0f8c9270a9719ec2"> 1128</a></span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; b</div><div class="line"><a name="l01129"></a><span class="lineno"> 1129</span>&#160; );</div><div class="line"><a name="l01130"></a><span class="lineno"> 1130</span>&#160;</div><div class="line"><a name="l01131"></a><span class="lineno"> 1131</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01132"></a><span class="lineno"><a class="line" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46"> 1132</a></span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01133"></a><span class="lineno"> 1133</span>&#160;<span class="comment"> Compares all fields</span></div><div class="line"><a name="l01134"></a><span class="lineno"> 1134</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01135"></a><span class="lineno"> 1135</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> Compare(</div><div class="line"><a name="l01136"></a><span class="lineno"> 1136</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; a,</div><div class="line"><a name="l01137"></a><span class="lineno"> 1137</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; b</div><div class="line"><a name="l01138"></a><span class="lineno"> 1138</span>&#160; );</div><div class="line"><a name="l01139"></a><span class="lineno"> 1139</span>&#160;</div><div class="line"><a name="l01140"></a><span class="lineno"> 1140</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01141"></a><span class="lineno"> 1141</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01142"></a><span class="lineno"> 1142</span>&#160;<span class="comment"> filename - [in]</span></div><div class="line"><a name="l01143"></a><span class="lineno"> 1143</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01144"></a><span class="lineno"> 1144</span>&#160;<span class="comment"> True if the file exists, has size &gt; 0, has the same name, same size, and same last modified time</span></div><div class="line"><a name="l01145"></a><span class="lineno"> 1145</span>&#160;<span class="comment"> than this content hash.</span></div><div class="line"><a name="l01146"></a><span class="lineno"> 1146</span>&#160;<span class="comment"> False otherwise.</span></div><div class="line"><a name="l01147"></a><span class="lineno"> 1147</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l01148"></a><span class="lineno"> 1148</span>&#160;<span class="comment"> Faster than the ON_ContentHash::EqualContent() and reliable if this content</span></div><div class="line"><a name="l01149"></a><span class="lineno"> 1149</span>&#160;<span class="comment"> hash was set on the same file system.</span></div><div class="line"><a name="l01150"></a><span class="lineno"> 1150</span>&#160;<span class="comment"> Unreliable if the file system does not correctly set last modified times</span></div><div class="line"><a name="l01151"></a><span class="lineno"> 1151</span>&#160;<span class="comment"> or the file was modified less than 2 seconds before the call.</span></div><div class="line"><a name="l01152"></a><span class="lineno"> 1152</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01153"></a><span class="lineno"> 1153</span>&#160; <span class="keywordtype">bool</span> EqualFileNameSizeAndTime(</div><div class="line"><a name="l01154"></a><span class="lineno"> 1154</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* filename</div><div class="line"><a name="l01155"></a><span class="lineno"> 1155</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01156"></a><span class="lineno"> 1156</span>&#160;</div><div class="line"><a name="l01157"></a><span class="lineno"> 1157</span>&#160; <span class="keywordtype">bool</span> Write(</div><div class="line"><a name="l01158"></a><span class="lineno"> 1158</span>&#160; <span class="keyword">class</span> <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l01159"></a><span class="lineno"> 1159</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01160"></a><span class="lineno"> 1160</span>&#160;</div><div class="line"><a name="l01161"></a><span class="lineno"> 1161</span>&#160; <span class="keywordtype">bool</span> Read(</div><div class="line"><a name="l01162"></a><span class="lineno"> 1162</span>&#160; <span class="keyword">class</span> <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l01163"></a><span class="lineno"> 1163</span>&#160; );</div><div class="line"><a name="l01164"></a><span class="lineno"> 1164</span>&#160;</div><div class="line"><a name="l01165"></a><span class="lineno"> 1165</span>&#160; <span class="keywordtype">void</span> Dump(</div><div class="line"><a name="l01166"></a><span class="lineno"> 1166</span>&#160; <span class="keyword">class</span> <a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>&amp; text_log</div><div class="line"><a name="l01167"></a><span class="lineno"> 1167</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01168"></a><span class="lineno"> 1168</span>&#160;</div><div class="line"><a name="l01169"></a><span class="lineno"> 1169</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l01170"></a><span class="lineno"> 1170</span>&#160; <span class="comment">// Number of bytes in the buffer or file</span></div><div class="line"><a name="l01171"></a><span class="lineno"> 1171</span>&#160; ON__UINT64 m_byte_count = 0;</div><div class="line"><a name="l01172"></a><span class="lineno"> 1172</span>&#160;</div><div class="line"><a name="l01173"></a><span class="lineno"> 1173</span>&#160; <span class="comment">// Time this hash was set (always &gt; 0 if this ON_ContentHash is set).</span></div><div class="line"><a name="l01174"></a><span class="lineno"> 1174</span>&#160; ON__UINT64 m_hash_time = 0; <span class="comment">// number of seconds since Jan 1, 1970, UCT</span></div><div class="line"><a name="l01175"></a><span class="lineno"> 1175</span>&#160;</div><div class="line"><a name="l01176"></a><span class="lineno"> 1176</span>&#160; <span class="comment">// Time the content was last modifed.</span></div><div class="line"><a name="l01177"></a><span class="lineno"> 1177</span>&#160; <span class="comment">// This time is often unknown, or set incorrectly.</span></div><div class="line"><a name="l01178"></a><span class="lineno"> 1178</span>&#160; ON__UINT64 m_content_time = 0; <span class="comment">// number of seconds since Jan 1, 1970, UCT</span></div><div class="line"><a name="l01179"></a><span class="lineno"> 1179</span>&#160;</div><div class="line"><a name="l01180"></a><span class="lineno"><a class="line" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876"> 1180</a></span>&#160; <span class="comment">// SHA-1 hash of the content name (file name or other assigned name)</span></div><div class="line"><a name="l01181"></a><span class="lineno"> 1181</span>&#160; <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> m_sha1_name_hash = <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html#a50683fde45600ba340667429fd8fd686">ON_SHA1_Hash::ZeroDigest</a>;</div><div class="line"><a name="l01182"></a><span class="lineno"> 1182</span>&#160;</div><div class="line"><a name="l01183"></a><span class="lineno"> 1183</span>&#160; <span class="comment">// SHA-1 hash of the content (buffer or file).</span></div><div class="line"><a name="l01184"></a><span class="lineno"> 1184</span>&#160; <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> m_sha1_content_hash = <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html#a50683fde45600ba340667429fd8fd686">ON_SHA1_Hash::ZeroDigest</a>;</div><div class="line"><a name="l01185"></a><span class="lineno"> 1185</span>&#160;};</div><div class="line"><a name="l01186"></a><span class="lineno"> 1186</span>&#160;</div><div class="line"><a name="l01187"></a><span class="lineno"> 1187</span>&#160;<span class="keyword">class </span>ON_CLASS <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a></div><div class="line"><a name="l01188"></a><span class="lineno"> 1188</span>&#160;{</div><div class="line"><a name="l01189"></a><span class="lineno"> 1189</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l01190"></a><span class="lineno"> 1190</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a> Unset;</div><div class="line"><a name="l01191"></a><span class="lineno"> 1191</span>&#160;</div><div class="line"><a name="l01192"></a><span class="lineno"> 1192</span>&#160;<span class="preprocessor">#pragma region RH_C_SHARED_ENUM [ON_FileReference::Status] [Rhino.FileIO.FileReferenceStatus] [int]</span></div><div class="line"><a name="l01193"></a><span class="lineno"> 1193</span>&#160;<span class="comment"> ///&lt;summary&gt;Enumerates a list of file statuses.&lt;/summary&gt;</span></div><div class="line"><a name="l01194"></a><span class="lineno"> 1194</span>&#160;<span class="comment"></span> <span class="keyword">enum class</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">Status</a> : unsigned int</div><div class="line"><a name="l01195"></a><span class="lineno"> 1195</span>&#160; {<span class="comment"></span></div><div class="line"><a name="l01196"></a><span class="lineno"> 1196</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01197"></a><span class="lineno"> 1197</span>&#160;<span class="comment"> /// Status of a the full path is not known.</span></div><div class="line"><a name="l01198"></a><span class="lineno"> 1198</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01199"></a><span class="lineno"> 1199</span>&#160;<span class="comment"></span> Unknown = 0,</div><div class="line"><a name="l01200"></a><span class="lineno"> 1200</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01201"></a><span class="lineno"> 1201</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01202"></a><span class="lineno"> 1202</span>&#160;<span class="comment"> /// Full path is valid.</span></div><div class="line"><a name="l01203"></a><span class="lineno"> 1203</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01204"></a><span class="lineno"> 1204</span>&#160;<span class="comment"></span> FullPathValid = 1,</div><div class="line"><a name="l01205"></a><span class="lineno"> 1205</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01206"></a><span class="lineno"> 1206</span>&#160;<span class="comment"> /// &lt;summary&gt;</span></div><div class="line"><a name="l01207"></a><span class="lineno"> 1207</span>&#160;<span class="comment"> /// Unable to locate file.</span></div><div class="line"><a name="l01208"></a><span class="lineno"> 1208</span>&#160;<span class="comment"> /// &lt;/summary&gt;</span></div><div class="line"><a name="l01209"></a><span class="lineno"> 1209</span>&#160;<span class="comment"></span> FileNotFound = 2 </div><div class="line"><a name="l01210"></a><span class="lineno"> 1210</span>&#160; };</div><div class="line"><a name="l01211"></a><span class="lineno"> 1211</span>&#160;<span class="preprocessor">#pragma endregion</span></div><div class="line"><a name="l01212"></a><span class="lineno"> 1212</span>&#160;</div><div class="line"><a name="l01213"></a><span class="lineno"> 1213</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> Compare(</div><div class="line"><a name="l01214"></a><span class="lineno"> 1214</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>&amp; a,</div><div class="line"><a name="l01215"></a><span class="lineno"> 1215</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>&amp; b</div><div class="line"><a name="l01216"></a><span class="lineno"> 1216</span>&#160; );</div><div class="line"><a name="l01217"></a><span class="lineno"> 1217</span>&#160;</div><div class="line"><a name="l01218"></a><span class="lineno"> 1218</span>&#160; <span class="keyword">static</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">ON_FileReference::Status</a> StatusFromUnsigned(</div><div class="line"><a name="l01219"></a><span class="lineno"> 1219</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> full_path_status_as_unsigned</div><div class="line"><a name="l01220"></a><span class="lineno"> 1220</span>&#160; );</div><div class="line"><a name="l01221"></a><span class="lineno"> 1221</span>&#160;</div><div class="line"><a name="l01222"></a><span class="lineno"> 1222</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l01223"></a><span class="lineno"> 1223</span>&#160; ~<a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l01224"></a><span class="lineno"> 1224</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>(<span class="keyword">const</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l01225"></a><span class="lineno"> 1225</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l01226"></a><span class="lineno"> 1226</span>&#160;</div><div class="line"><a name="l01227"></a><span class="lineno"> 1227</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>(</div><div class="line"><a name="l01228"></a><span class="lineno"> 1228</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* full_path,</div><div class="line"><a name="l01229"></a><span class="lineno"> 1229</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* relative_path,</div><div class="line"><a name="l01230"></a><span class="lineno"> 1230</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> content_hash,</div><div class="line"><a name="l01231"></a><span class="lineno"> 1231</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">ON_FileReference::Status</a> full_path_status</div><div class="line"><a name="l01232"></a><span class="lineno"> 1232</span>&#160; );</div><div class="line"><a name="l01233"></a><span class="lineno"> 1233</span>&#160;</div><div class="line"><a name="l01234"></a><span class="lineno"> 1234</span>&#160; <span class="keyword">static</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a> CreateFromFullPath(</div><div class="line"><a name="l01235"></a><span class="lineno"> 1235</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* full_path,</div><div class="line"><a name="l01236"></a><span class="lineno"> 1236</span>&#160; <span class="keywordtype">bool</span> bSetContentHash,</div><div class="line"><a name="l01237"></a><span class="lineno"> 1237</span>&#160; <span class="keywordtype">bool</span> bSetFullPathStatus</div><div class="line"><a name="l01238"></a><span class="lineno"> 1238</span>&#160; );</div><div class="line"><a name="l01239"></a><span class="lineno"> 1239</span>&#160;</div><div class="line"><a name="l01240"></a><span class="lineno"> 1240</span>&#160;<span class="preprocessor">#pragma region RH_C_SHARED_ENUM [ON_FileReference::FindFilePreference] [Rhino.FileIO.FileFindPreference] [int]</span></div><div class="line"><a name="l01241"></a><span class="lineno"> 1241</span>&#160;<span class="comment"> ///&lt;summary&gt;Defines options for file search.&lt;/summary&gt;</span></div><div class="line"><a name="l01242"></a><span class="lineno"> 1242</span>&#160;<span class="comment"></span> <span class="keyword">enum class</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">FindFilePreference</a> : unsigned char</div><div class="line"><a name="l01243"></a><span class="lineno"> 1243</span>&#160; {<span class="comment"></span></div><div class="line"><a name="l01244"></a><span class="lineno"> 1244</span>&#160;<span class="comment"> ///&lt;summary&gt;The choice is not defined.&lt;/summary&gt;</span></div><div class="line"><a name="l01245"></a><span class="lineno"> 1245</span>&#160;<span class="comment"></span> None = 0,</div><div class="line"><a name="l01246"></a><span class="lineno"> 1246</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01247"></a><span class="lineno"> 1247</span>&#160;<span class="comment"> ///&lt;summary&gt;File name exists in FullPath().&lt;/summary&gt;</span></div><div class="line"><a name="l01248"></a><span class="lineno"> 1248</span>&#160;<span class="comment"></span> FullPath = 1,</div><div class="line"><a name="l01249"></a><span class="lineno"> 1249</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01250"></a><span class="lineno"> 1250</span>&#160;<span class="comment"> ///&lt;summary&gt;File name exists in base path + RelativePath().&lt;/summary&gt;</span></div><div class="line"><a name="l01251"></a><span class="lineno"> 1251</span>&#160;<span class="comment"></span> RelativePath = 2,</div><div class="line"><a name="l01252"></a><span class="lineno"> 1252</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01253"></a><span class="lineno"> 1253</span>&#160;<span class="comment"> ///&lt;summary&gt;File name exists in base path directory.&lt;/summary&gt;</span></div><div class="line"><a name="l01254"></a><span class="lineno"> 1254</span>&#160;<span class="comment"></span> BasePath = 3,</div><div class="line"><a name="l01255"></a><span class="lineno"> 1255</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01256"></a><span class="lineno"> 1256</span>&#160;<span class="comment"> ///&lt;summary&gt;File with mathing content exists.&lt;/summary&gt;</span></div><div class="line"><a name="l01257"></a><span class="lineno"> 1257</span>&#160;<span class="comment"></span> ContentMatch = 4,</div><div class="line"><a name="l01258"></a><span class="lineno"> 1258</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01259"></a><span class="lineno"> 1259</span>&#160;<span class="comment"> ///&lt;summary&gt;Most recently modifed file.&lt;/summary&gt;</span></div><div class="line"><a name="l01260"></a><span class="lineno"> 1260</span>&#160;<span class="comment"></span> MostRecent = 5</div><div class="line"><a name="l01261"></a><span class="lineno"> 1261</span>&#160; };</div><div class="line"><a name="l01262"></a><span class="lineno"> 1262</span>&#160;<span class="preprocessor">#pragma endregion</span></div><div class="line"><a name="l01263"></a><span class="lineno"> 1263</span>&#160;</div><div class="line"><a name="l01264"></a><span class="lineno"> 1264</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01265"></a><span class="lineno"> 1265</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01266"></a><span class="lineno"> 1266</span>&#160;<span class="comment"> Uses the full path, relative path and parameter information to find a</span></div><div class="line"><a name="l01267"></a><span class="lineno"> 1267</span>&#160;<span class="comment"> full path to a file that exists.</span></div><div class="line"><a name="l01268"></a><span class="lineno"> 1268</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01269"></a><span class="lineno"> 1269</span>&#160;<span class="comment"> base_path - [in]</span></div><div class="line"><a name="l01270"></a><span class="lineno"> 1270</span>&#160;<span class="comment"> If base_path and RelativePath() are not empty, then path base_path+RelativePath().</span></div><div class="line"><a name="l01271"></a><span class="lineno"> 1271</span>&#160;<span class="comment"> If base_path is not empty, then base_path + filename is considered.</span></div><div class="line"><a name="l01272"></a><span class="lineno"> 1272</span>&#160;<span class="comment"> bBasePathIncludesFileName - [in]</span></div><div class="line"><a name="l01273"></a><span class="lineno"> 1273</span>&#160;<span class="comment"> True if base_path contains a file name that must be removed to get a directory path.</span></div><div class="line"><a name="l01274"></a><span class="lineno"> 1274</span>&#160;<span class="comment"> first_choice - [in]</span></div><div class="line"><a name="l01275"></a><span class="lineno"> 1275</span>&#160;<span class="comment"> When multiple files are found in different locations, the first_choice, second_choice,</span></div><div class="line"><a name="l01276"></a><span class="lineno"> 1276</span>&#160;<span class="comment"> third_choice, forth_choice, and fifth_choice parameters are used to select which file</span></div><div class="line"><a name="l01277"></a><span class="lineno"> 1277</span>&#160;<span class="comment"> is returned.</span></div><div class="line"><a name="l01278"></a><span class="lineno"> 1278</span>&#160;<span class="comment"> second_choice - [in]</span></div><div class="line"><a name="l01279"></a><span class="lineno"> 1279</span>&#160;<span class="comment"> When multiple files are found in different locations, the first_choice, second_choice,</span></div><div class="line"><a name="l01280"></a><span class="lineno"> 1280</span>&#160;<span class="comment"> third_choice, forth_choice, and fifth_choice parameters are used to select which file</span></div><div class="line"><a name="l01281"></a><span class="lineno"> 1281</span>&#160;<span class="comment"> is returned.</span></div><div class="line"><a name="l01282"></a><span class="lineno"> 1282</span>&#160;<span class="comment"> third_choice - [in]</span></div><div class="line"><a name="l01283"></a><span class="lineno"> 1283</span>&#160;<span class="comment"> When multiple files are found in different locations, the first_choice, second_choice,</span></div><div class="line"><a name="l01284"></a><span class="lineno"> 1284</span>&#160;<span class="comment"> third_choice, forth_choice, and fifth_choice parameters are used to select which file</span></div><div class="line"><a name="l01285"></a><span class="lineno"> 1285</span>&#160;<span class="comment"> is returned.</span></div><div class="line"><a name="l01286"></a><span class="lineno"> 1286</span>&#160;<span class="comment"> forth_choice - [in]</span></div><div class="line"><a name="l01287"></a><span class="lineno"> 1287</span>&#160;<span class="comment"> When multiple files are found in different locations, the first_choice, second_choice,</span></div><div class="line"><a name="l01288"></a><span class="lineno"> 1288</span>&#160;<span class="comment"> third_choice, forth_choice, and fifth_choice parameters are used to select which file</span></div><div class="line"><a name="l01289"></a><span class="lineno"> 1289</span>&#160;<span class="comment"> is returned.</span></div><div class="line"><a name="l01290"></a><span class="lineno"> 1290</span>&#160;<span class="comment"> fifth_choice - [in]</span></div><div class="line"><a name="l01291"></a><span class="lineno"> 1291</span>&#160;<span class="comment"> When multiple files are found in different locations, the first_choice, second_choice,</span></div><div class="line"><a name="l01292"></a><span class="lineno"> 1292</span>&#160;<span class="comment"> third_choice, forth_choice, and fifth_choice parameters are used to select which file</span></div><div class="line"><a name="l01293"></a><span class="lineno"> 1293</span>&#160;<span class="comment"> is returned.</span></div><div class="line"><a name="l01294"></a><span class="lineno"> 1294</span>&#160;<span class="comment"> full_path - [out]</span></div><div class="line"><a name="l01295"></a><span class="lineno"> 1295</span>&#160;<span class="comment"> A full path to a file that exists.</span></div><div class="line"><a name="l01296"></a><span class="lineno"> 1296</span>&#160;<span class="comment"> If FullPath() and base_path+RelativePath() resolve to different files, </span></div><div class="line"><a name="l01297"></a><span class="lineno"> 1297</span>&#160;<span class="comment"> the content hash information is used to select the file.</span></div><div class="line"><a name="l01298"></a><span class="lineno"> 1298</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01299"></a><span class="lineno"> 1299</span>&#160;<span class="comment"> If the file is found, then the returned ON_FileReference::FindFilePreference enum value</span></div><div class="line"><a name="l01300"></a><span class="lineno"> 1300</span>&#160;<span class="comment"> indicates why it was selected.</span></div><div class="line"><a name="l01301"></a><span class="lineno"> 1301</span>&#160;<span class="comment"> If the file is not found, then ON_FileReference::FindFilePreference::None is returned</span></div><div class="line"><a name="l01302"></a><span class="lineno"> 1302</span>&#160;<span class="comment"> and full_path is empty.</span></div><div class="line"><a name="l01303"></a><span class="lineno"> 1303</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l01304"></a><span class="lineno"> 1304</span>&#160;<span class="comment"> The locations FullPath(), base_path+RelativePath(), and base_path+FileName() are tested.</span></div><div class="line"><a name="l01305"></a><span class="lineno"> 1305</span>&#160;<span class="comment"> If multiple files are found, first_choice, second_choice, third_choice, forth_choice,</span></div><div class="line"><a name="l01306"></a><span class="lineno"> 1306</span>&#160;<span class="comment"> and fifth_choice are used to select which file is returned.</span></div><div class="line"><a name="l01307"></a><span class="lineno"> 1307</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01308"></a><span class="lineno"> 1308</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> FindFile(</div><div class="line"><a name="l01309"></a><span class="lineno"> 1309</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l01310"></a><span class="lineno"> 1310</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName,</div><div class="line"><a name="l01311"></a><span class="lineno"> 1311</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> first_choice,</div><div class="line"><a name="l01312"></a><span class="lineno"> 1312</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> second_choice,</div><div class="line"><a name="l01313"></a><span class="lineno"> 1313</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> third_choice,</div><div class="line"><a name="l01314"></a><span class="lineno"> 1314</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> forth_choice,</div><div class="line"><a name="l01315"></a><span class="lineno"> 1315</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> fifth_choice,</div><div class="line"><a name="l01316"></a><span class="lineno"> 1316</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>&amp; found_file_full_path</div><div class="line"><a name="l01317"></a><span class="lineno"> 1317</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01318"></a><span class="lineno"> 1318</span>&#160;</div><div class="line"><a name="l01319"></a><span class="lineno"> 1319</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01320"></a><span class="lineno"> 1320</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01321"></a><span class="lineno"> 1321</span>&#160;<span class="comment"> Uses the full path, relative path and parameter information to find a</span></div><div class="line"><a name="l01322"></a><span class="lineno"> 1322</span>&#160;<span class="comment"> full path to a file that exists.</span></div><div class="line"><a name="l01323"></a><span class="lineno"> 1323</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01324"></a><span class="lineno"> 1324</span>&#160;<span class="comment"> base_path - [in]</span></div><div class="line"><a name="l01325"></a><span class="lineno"> 1325</span>&#160;<span class="comment"> If base_path and RelativePath() are not empty, then path base_path+RelativePath().</span></div><div class="line"><a name="l01326"></a><span class="lineno"> 1326</span>&#160;<span class="comment"> If base_path is not empty, then base_path + filename is considered.</span></div><div class="line"><a name="l01327"></a><span class="lineno"> 1327</span>&#160;<span class="comment"> bBasePathIncludesFileName - [in]</span></div><div class="line"><a name="l01328"></a><span class="lineno"> 1328</span>&#160;<span class="comment"> True if base_path contains a file name that must be removed to get a directory path.</span></div><div class="line"><a name="l01329"></a><span class="lineno"> 1329</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01330"></a><span class="lineno"> 1330</span>&#160;<span class="comment"> If the file is found, then the returned ON_FileReference::FindFilePreference enum value</span></div><div class="line"><a name="l01331"></a><span class="lineno"> 1331</span>&#160;<span class="comment"> indicates why it was selected.</span></div><div class="line"><a name="l01332"></a><span class="lineno"> 1332</span>&#160;<span class="comment"> If the file is not found, then ON_FileReference::FindFilePreference::None is returned</span></div><div class="line"><a name="l01333"></a><span class="lineno"> 1333</span>&#160;<span class="comment"> and full_path is empty.</span></div><div class="line"><a name="l01334"></a><span class="lineno"> 1334</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l01335"></a><span class="lineno"> 1335</span>&#160;<span class="comment"> The locations FullPath(), base_path+RelativePath(), and base_path+FileName() are tested.</span></div><div class="line"><a name="l01336"></a><span class="lineno"> 1336</span>&#160;<span class="comment"> If multiple files are found, the returned file is selected in the order</span></div><div class="line"><a name="l01337"></a><span class="lineno"> 1337</span>&#160;<span class="comment"> relative path, full path, content match, base path and most recently modified.</span></div><div class="line"><a name="l01338"></a><span class="lineno"> 1338</span>&#160;<span class="comment"> If you prefer a different order, use the version of ON_FileReference::FindFile</span></div><div class="line"><a name="l01339"></a><span class="lineno"> 1339</span>&#160;<span class="comment"> with 5 ON_FileReference::FindFilePreference parameters.</span></div><div class="line"><a name="l01340"></a><span class="lineno"> 1340</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01341"></a><span class="lineno"> 1341</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> FindFile(</div><div class="line"><a name="l01342"></a><span class="lineno"> 1342</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l01343"></a><span class="lineno"> 1343</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName,</div><div class="line"><a name="l01344"></a><span class="lineno"> 1344</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>&amp; found_file_full_path</div><div class="line"><a name="l01345"></a><span class="lineno"> 1345</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01346"></a><span class="lineno"> 1346</span>&#160;</div><div class="line"><a name="l01347"></a><span class="lineno"> 1347</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01348"></a><span class="lineno"> 1348</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01349"></a><span class="lineno"> 1349</span>&#160;<span class="comment"> The search for the file is identical to the one performed by find file.</span></div><div class="line"><a name="l01350"></a><span class="lineno"> 1350</span>&#160;<span class="comment"> If a file is found, the full path setting in this reference is updated.</span></div><div class="line"><a name="l01351"></a><span class="lineno"> 1351</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01352"></a><span class="lineno"> 1352</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> FindFileAndUpdateReference(</div><div class="line"><a name="l01353"></a><span class="lineno"> 1353</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l01354"></a><span class="lineno"> 1354</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName,</div><div class="line"><a name="l01355"></a><span class="lineno"> 1355</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> first_choice,</div><div class="line"><a name="l01356"></a><span class="lineno"> 1356</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> second_choice,</div><div class="line"><a name="l01357"></a><span class="lineno"> 1357</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> third_choice,</div><div class="line"><a name="l01358"></a><span class="lineno"> 1358</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> forth_choice,</div><div class="line"><a name="l01359"></a><span class="lineno"> 1359</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> fifth_choice,</div><div class="line"><a name="l01360"></a><span class="lineno"> 1360</span>&#160; <span class="keywordtype">bool</span> bUpdateContentHash,</div><div class="line"><a name="l01361"></a><span class="lineno"> 1361</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>&amp; found_file_full_path</div><div class="line"><a name="l01362"></a><span class="lineno"> 1362</span>&#160; );</div><div class="line"><a name="l01363"></a><span class="lineno"> 1363</span>&#160;</div><div class="line"><a name="l01364"></a><span class="lineno"> 1364</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01365"></a><span class="lineno"> 1365</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01366"></a><span class="lineno"> 1366</span>&#160;<span class="comment"> The search for the file is identical to the one performed by find file.</span></div><div class="line"><a name="l01367"></a><span class="lineno"> 1367</span>&#160;<span class="comment"> If a file is found, the full path setting in this reference is updated.</span></div><div class="line"><a name="l01368"></a><span class="lineno"> 1368</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01369"></a><span class="lineno"> 1369</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> FindFileAndUpdateReference(</div><div class="line"><a name="l01370"></a><span class="lineno"> 1370</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l01371"></a><span class="lineno"> 1371</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName,</div><div class="line"><a name="l01372"></a><span class="lineno"> 1372</span>&#160; <span class="keywordtype">bool</span> bUpdateContentHash,</div><div class="line"><a name="l01373"></a><span class="lineno"> 1373</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>&amp; found_file_full_path</div><div class="line"><a name="l01374"></a><span class="lineno"> 1374</span>&#160; );</div><div class="line"><a name="l01375"></a><span class="lineno"> 1375</span>&#160;</div><div class="line"><a name="l01376"></a><span class="lineno"> 1376</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> FindFileAndUpdateReference(</div><div class="line"><a name="l01377"></a><span class="lineno"> 1377</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l01378"></a><span class="lineno"> 1378</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName,</div><div class="line"><a name="l01379"></a><span class="lineno"> 1379</span>&#160; <span class="keywordtype">bool</span> bUpdateContentHash</div><div class="line"><a name="l01380"></a><span class="lineno"> 1380</span>&#160; );</div><div class="line"><a name="l01381"></a><span class="lineno"> 1381</span>&#160;</div><div class="line"><a name="l01382"></a><span class="lineno"> 1382</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01383"></a><span class="lineno"> 1383</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01384"></a><span class="lineno"> 1384</span>&#160;<span class="comment"> True if FullPath() is not empty.</span></div><div class="line"><a name="l01385"></a><span class="lineno"> 1385</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01386"></a><span class="lineno"> 1386</span>&#160; <span class="keywordtype">bool</span> IsSet() <span class="keyword">const</span>;</div><div class="line"><a name="l01387"></a><span class="lineno"> 1387</span>&#160;</div><div class="line"><a name="l01388"></a><span class="lineno"> 1388</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01389"></a><span class="lineno"> 1389</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01390"></a><span class="lineno"> 1390</span>&#160;<span class="comment"> True if FullPath() is empty.</span></div><div class="line"><a name="l01391"></a><span class="lineno"> 1391</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01392"></a><span class="lineno"> 1392</span>&#160; <span class="keywordtype">bool</span> IsNotSet() <span class="keyword">const</span>;</div><div class="line"><a name="l01393"></a><span class="lineno"> 1393</span>&#160;</div><div class="line"><a name="l01394"></a><span class="lineno"> 1394</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01395"></a><span class="lineno"> 1395</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01396"></a><span class="lineno"> 1396</span>&#160;<span class="comment"> bUseArchiveBasePath - [in]</span></div><div class="line"><a name="l01397"></a><span class="lineno"> 1397</span>&#160;<span class="comment"> If bUseArchiveBasePath is true and a file is being written, then the</span></div><div class="line"><a name="l01398"></a><span class="lineno"> 1398</span>&#160;<span class="comment"> base path of the file being written use used as the base path to</span></div><div class="line"><a name="l01399"></a><span class="lineno"> 1399</span>&#160;<span class="comment"> calculate the relative path.</span></div><div class="line"><a name="l01400"></a><span class="lineno"> 1400</span>&#160;<span class="comment"> If bUseArchiveBasePath is false, then the current value of RelativePath() </span></div><div class="line"><a name="l01401"></a><span class="lineno"> 1401</span>&#160;<span class="comment"> is saved in the archive.</span></div><div class="line"><a name="l01402"></a><span class="lineno"> 1402</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01403"></a><span class="lineno"> 1403</span>&#160; <span class="keywordtype">bool</span> Write(</div><div class="line"><a name="l01404"></a><span class="lineno"> 1404</span>&#160; <span class="keywordtype">bool</span> bUseArchiveDirectoryAsBasePath,</div><div class="line"><a name="l01405"></a><span class="lineno"> 1405</span>&#160; <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l01406"></a><span class="lineno"> 1406</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01407"></a><span class="lineno"> 1407</span>&#160;</div><div class="line"><a name="l01408"></a><span class="lineno"> 1408</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01409"></a><span class="lineno"> 1409</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01410"></a><span class="lineno"> 1410</span>&#160;<span class="comment"> base_path - [in]</span></div><div class="line"><a name="l01411"></a><span class="lineno"> 1411</span>&#160;<span class="comment"> If base_path is not empty, then the relative path saved</span></div><div class="line"><a name="l01412"></a><span class="lineno"> 1412</span>&#160;<span class="comment"> in the archive will be calculated from FullPath() and base_path.</span></div><div class="line"><a name="l01413"></a><span class="lineno"> 1413</span>&#160;<span class="comment"> If base_path is nullptr or empty, then RelativePath() is saved in</span></div><div class="line"><a name="l01414"></a><span class="lineno"> 1414</span>&#160;<span class="comment"> the archive.</span></div><div class="line"><a name="l01415"></a><span class="lineno"> 1415</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01416"></a><span class="lineno"> 1416</span>&#160; <span class="keywordtype">bool</span> Write(</div><div class="line"><a name="l01417"></a><span class="lineno"> 1417</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l01418"></a><span class="lineno"> 1418</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName,</div><div class="line"><a name="l01419"></a><span class="lineno"> 1419</span>&#160; <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l01420"></a><span class="lineno"> 1420</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01421"></a><span class="lineno"> 1421</span>&#160;</div><div class="line"><a name="l01422"></a><span class="lineno"> 1422</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01423"></a><span class="lineno"> 1423</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l01424"></a><span class="lineno"> 1424</span>&#160;<span class="comment"> Calling Read() sets m_full_path_status = ON_FileReference::Status::Unknown,</span></div><div class="line"><a name="l01425"></a><span class="lineno"> 1425</span>&#160;<span class="comment"> even if that was not the status when Write() was called.</span></div><div class="line"><a name="l01426"></a><span class="lineno"> 1426</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01427"></a><span class="lineno"> 1427</span>&#160; <span class="keywordtype">bool</span> Read(</div><div class="line"><a name="l01428"></a><span class="lineno"> 1428</span>&#160; <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l01429"></a><span class="lineno"> 1429</span>&#160; );</div><div class="line"><a name="l01430"></a><span class="lineno"> 1430</span>&#160;</div><div class="line"><a name="l01431"></a><span class="lineno"> 1431</span>&#160; <span class="keywordtype">void</span> Dump(</div><div class="line"><a name="l01432"></a><span class="lineno"> 1432</span>&#160; <span class="keyword">class</span> <a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>&amp; text_log</div><div class="line"><a name="l01433"></a><span class="lineno"> 1433</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01434"></a><span class="lineno"> 1434</span>&#160;</div><div class="line"><a name="l01435"></a><span class="lineno"> 1435</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SizeOf() <span class="keyword">const</span>;</div><div class="line"><a name="l01436"></a><span class="lineno"> 1436</span>&#160;</div><div class="line"><a name="l01437"></a><span class="lineno"> 1437</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>&amp; FullPath() <span class="keyword">const</span>;</div><div class="line"><a name="l01438"></a><span class="lineno"> 1438</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* FullPathAsPointer() <span class="keyword">const</span>;</div><div class="line"><a name="l01439"></a><span class="lineno"> 1439</span>&#160; <span class="keywordtype">void</span> SetFullPath(</div><div class="line"><a name="l01440"></a><span class="lineno"> 1440</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* full_path,</div><div class="line"><a name="l01441"></a><span class="lineno"> 1441</span>&#160; <span class="keywordtype">bool</span> bSetContentHash</div><div class="line"><a name="l01442"></a><span class="lineno"> 1442</span>&#160; );</div><div class="line"><a name="l01443"></a><span class="lineno"> 1443</span>&#160; <span class="keywordtype">void</span> SetFullPath(</div><div class="line"><a name="l01444"></a><span class="lineno"> 1444</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* full_path,</div><div class="line"><a name="l01445"></a><span class="lineno"> 1445</span>&#160; <span class="keywordtype">bool</span> bSetContentHash</div><div class="line"><a name="l01446"></a><span class="lineno"> 1446</span>&#160; );</div><div class="line"><a name="l01447"></a><span class="lineno"> 1447</span>&#160; <span class="keywordtype">void</span> ClearFullPath();</div><div class="line"><a name="l01448"></a><span class="lineno"> 1448</span>&#160; </div><div class="line"><a name="l01449"></a><span class="lineno"> 1449</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>&amp; RelativePath() <span class="keyword">const</span>;</div><div class="line"><a name="l01450"></a><span class="lineno"> 1450</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* RelativePathAsPointer() <span class="keyword">const</span>;</div><div class="line"><a name="l01451"></a><span class="lineno"> 1451</span>&#160; <span class="keywordtype">void</span> SetRelativePath(</div><div class="line"><a name="l01452"></a><span class="lineno"> 1452</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* relative_path</div><div class="line"><a name="l01453"></a><span class="lineno"> 1453</span>&#160; );</div><div class="line"><a name="l01454"></a><span class="lineno"> 1454</span>&#160; <span class="keywordtype">void</span> SetRelativePath(</div><div class="line"><a name="l01455"></a><span class="lineno"> 1455</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* relative_path</div><div class="line"><a name="l01456"></a><span class="lineno"> 1456</span>&#160; );</div><div class="line"><a name="l01457"></a><span class="lineno"> 1457</span>&#160; <span class="keywordtype">void</span> SetRelativePathFromBasePath(</div><div class="line"><a name="l01458"></a><span class="lineno"> 1458</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l01459"></a><span class="lineno"> 1459</span>&#160; <span class="keywordtype">bool</span> bBasePathContainsFileName</div><div class="line"><a name="l01460"></a><span class="lineno"> 1460</span>&#160; );</div><div class="line"><a name="l01461"></a><span class="lineno"> 1461</span>&#160; <span class="keywordtype">void</span> SetRelativePathFromBasePath(</div><div class="line"><a name="l01462"></a><span class="lineno"> 1462</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* base_path,</div><div class="line"><a name="l01463"></a><span class="lineno"> 1463</span>&#160; <span class="keywordtype">bool</span> bBasePathContainsFileName</div><div class="line"><a name="l01464"></a><span class="lineno"> 1464</span>&#160; );</div><div class="line"><a name="l01465"></a><span class="lineno"> 1465</span>&#160; <span class="keywordtype">void</span> ClearRelativePath();</div><div class="line"><a name="l01466"></a><span class="lineno"> 1466</span>&#160;</div><div class="line"><a name="l01467"></a><span class="lineno"> 1467</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01468"></a><span class="lineno"> 1468</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01469"></a><span class="lineno"> 1469</span>&#160;<span class="comment"> File content hash. This value is persistent, saved in 3dm archive,</span></div><div class="line"><a name="l01470"></a><span class="lineno"> 1470</span>&#160;<span class="comment"> and could have been calculated a long time ago on a different computer.</span></div><div class="line"><a name="l01471"></a><span class="lineno"> 1471</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01472"></a><span class="lineno"> 1472</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; ContentHash() <span class="keyword">const</span>;</div><div class="line"><a name="l01473"></a><span class="lineno"> 1473</span>&#160; <span class="keywordtype">void</span> SetContentHash(</div><div class="line"><a name="l01474"></a><span class="lineno"> 1474</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> content_hash</div><div class="line"><a name="l01475"></a><span class="lineno"> 1475</span>&#160; );</div><div class="line"><a name="l01476"></a><span class="lineno"> 1476</span>&#160; <span class="keywordtype">void</span> ClearContentHash();</div><div class="line"><a name="l01477"></a><span class="lineno"> 1477</span>&#160;</div><div class="line"><a name="l01478"></a><span class="lineno"> 1478</span>&#160; <span class="keywordtype">bool</span> UpdateContentHash();</div><div class="line"><a name="l01479"></a><span class="lineno"> 1479</span>&#160;</div><div class="line"><a name="l01480"></a><span class="lineno"><a class="line" href="../../d5/db7/class_o_n___file_iterator.html"> 1480</a></span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01481"></a><span class="lineno"> 1481</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01482"></a><span class="lineno"> 1482</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01483"></a><span class="lineno"> 1483</span>&#160;<span class="comment"> recent_time - [in]</span></div><div class="line"><a name="l01484"></a><span class="lineno"> 1484</span>&#160;<span class="comment"> The time, in number of seconds since January 1, 1970 UTC, to use</span></div><div class="line"><a name="l01485"></a><span class="lineno"> 1485</span>&#160;<span class="comment"> when deciding what content hashes can be considered recent.</span></div><div class="line"><a name="l01486"></a><span class="lineno"> 1486</span>&#160;<span class="comment"> If recent_time is 0 or in the future, then the current value of</span></div><div class="line"><a name="l01487"></a><span class="lineno"> 1487</span>&#160;<span class="comment"> ON_SecondsSinceJanOne1970UTC() is used.</span></div><div class="line"><a name="l01488"></a><span class="lineno"> 1488</span>&#160;<span class="comment"> Typically this parameter is the value of ON_SecondsSinceJanOne1970UTC()</span></div><div class="line"><a name="l01489"></a><span class="lineno"> 1489</span>&#160;<span class="comment"> at the beginning of a calculation durint which any referenced files will</span></div><div class="line"><a name="l01490"></a><span class="lineno"> 1490</span>&#160;<span class="comment"> not be changed. </span></div><div class="line"><a name="l01491"></a><span class="lineno"> 1491</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01492"></a><span class="lineno"> 1492</span>&#160;<span class="comment"> A file content hash value calculated on or after a specified time in the current</span></div><div class="line"><a name="l01493"></a><span class="lineno"> 1493</span>&#160;<span class="comment"> instance of the application. This value is used to detect changed files</span></div><div class="line"><a name="l01494"></a><span class="lineno"> 1494</span>&#160;<span class="comment"> in the current instance of the application. It is cached for performance reasons.</span></div><div class="line"><a name="l01495"></a><span class="lineno"> 1495</span>&#160;<span class="comment"> This value is never saved in 3dm files.</span></div><div class="line"><a name="l01496"></a><span class="lineno"> 1496</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01497"></a><span class="lineno"> 1497</span>&#160; <span class="keyword">const</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>&amp; RecentContentHash(</div><div class="line"><a name="l01498"></a><span class="lineno"> 1498</span>&#160; ON__UINT64 recent_time</div><div class="line"><a name="l01499"></a><span class="lineno"> 1499</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01500"></a><span class="lineno"> 1500</span>&#160;</div><div class="line"><a name="l01501"></a><span class="lineno"> 1501</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01502"></a><span class="lineno"> 1502</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01503"></a><span class="lineno"> 1503</span>&#160;<span class="comment"> ON_SHA1_Hash::FileSystemPathHash(FullPath());</span></div><div class="line"><a name="l01504"></a><span class="lineno"> 1504</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l01505"></a><span class="lineno"> 1505</span>&#160;<span class="comment"> The value of the hash is saved in a runtime cache so</span></div><div class="line"><a name="l01506"></a><span class="lineno"> 1506</span>&#160;<span class="comment"> using this function when comparing paths is efficient</span></div><div class="line"><a name="l01507"></a><span class="lineno"> 1507</span>&#160;<span class="comment"> when multple compares are required.</span></div><div class="line"><a name="l01508"></a><span class="lineno"> 1508</span>&#160;<span class="comment"> See Also:</span></div><div class="line"><a name="l01509"></a><span class="lineno"> 1509</span>&#160;<span class="comment"> ON_NameHash::CreateFilePathHash( ON_FileReference&amp; file_reference );</span></div><div class="line"><a name="l01510"></a><span class="lineno"> 1510</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01511"></a><span class="lineno"> 1511</span>&#160; <span class="keyword">const</span> <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a>&amp; FullPathHash() <span class="keyword">const</span>;</div><div class="line"><a name="l01512"></a><span class="lineno"> 1512</span>&#160;</div><div class="line"><a name="l01513"></a><span class="lineno"> 1513</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">ON_FileReference::Status</a> FullPathStatus() <span class="keyword">const</span>;</div><div class="line"><a name="l01514"></a><span class="lineno"> 1514</span>&#160; <span class="keywordtype">void</span> SetFullPathStatus(</div><div class="line"><a name="l01515"></a><span class="lineno"> 1515</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">ON_FileReference::Status</a> full_path_status</div><div class="line"><a name="l01516"></a><span class="lineno"> 1516</span>&#160; );</div><div class="line"><a name="l01517"></a><span class="lineno"> 1517</span>&#160;</div><div class="line"><a name="l01518"></a><span class="lineno"> 1518</span>&#160; <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> EmbeddedFileId() <span class="keyword">const</span>;</div><div class="line"><a name="l01519"></a><span class="lineno"> 1519</span>&#160; <span class="keywordtype">void</span> SetEmbeddedFileId(</div><div class="line"><a name="l01520"></a><span class="lineno"> 1520</span>&#160; <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> embedded_file_id</div><div class="line"><a name="l01521"></a><span class="lineno"> 1521</span>&#160; );</div><div class="line"><a name="l01522"></a><span class="lineno"> 1522</span>&#160;</div><div class="line"><a name="l01523"></a><span class="lineno"> 1523</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l01524"></a><span class="lineno"> 1524</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> m_full_path;</div><div class="line"><a name="l01525"></a><span class="lineno"> 1525</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> m_relative_path;</div><div class="line"><a name="l01526"></a><span class="lineno"> 1526</span>&#160;</div><div class="line"><a name="l01527"></a><span class="lineno"> 1527</span>&#160; <span class="comment">// If the referenced file is saved in the model as an embedded file,</span></div><div class="line"><a name="l01528"></a><span class="lineno"> 1528</span>&#160; <span class="comment">// the ON_BinaryArchive read code sets m_embedded_file_id</span></div><div class="line"><a name="l01529"></a><span class="lineno"> 1529</span>&#160; <span class="comment">// at read time.</span></div><div class="line"><a name="l01530"></a><span class="lineno"> 1530</span>&#160; <span class="keyword">mutable</span> <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> m_embedded_file_id = ON_nil_uuid;</div><div class="line"><a name="l01531"></a><span class="lineno"> 1531</span>&#160;</div><div class="line"><a name="l01532"></a><span class="lineno"> 1532</span>&#160; <span class="comment">// file content hash. Can be calculated long ago, on a different computer,</span></div><div class="line"><a name="l01533"></a><span class="lineno"> 1533</span>&#160; <span class="comment">// and is saved in 3dm archived.</span></div><div class="line"><a name="l01534"></a><span class="lineno"> 1534</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> m_content_hash; <span class="comment">// File content hash.</span></div><div class="line"><a name="l01535"></a><span class="lineno"> 1535</span>&#160;</div><div class="line"><a name="l01536"></a><span class="lineno"> 1536</span>&#160; <span class="keyword">mutable</span> <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a> m_recent_content_hash;</div><div class="line"><a name="l01537"></a><span class="lineno"> 1537</span>&#160;</div><div class="line"><a name="l01538"></a><span class="lineno"> 1538</span>&#160; <span class="comment">// m_full_path_hash is chached runtime information. The value is not saved</span></div><div class="line"><a name="l01539"></a><span class="lineno"> 1539</span>&#160; <span class="comment">// in .3dm archives. It is calculated on demand.</span></div><div class="line"><a name="l01540"></a><span class="lineno"> 1540</span>&#160; <span class="keyword">mutable</span> <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> m_full_path_hash = <a class="code" href="../../dd/ddf/class_o_n___s_h_a1___hash.html#a5fbd8257f1b9c3fdfc929d3869113924">ON_SHA1_Hash::EmptyContentHash</a>; <span class="comment">// File path hash.</span></div><div class="line"><a name="l01541"></a><span class="lineno"> 1541</span>&#160;</div><div class="line"><a name="l01542"></a><span class="lineno"> 1542</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">ON_FileReference::Status</a> m_full_path_status = <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46a88183b946cc5f0e8c96b2e66e1c74a7e">ON_FileReference::Status::Unknown</a>;</div><div class="line"><a name="l01543"></a><span class="lineno"> 1543</span>&#160;</div><div class="line"><a name="l01544"></a><span class="lineno"> 1544</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l01545"></a><span class="lineno"> 1545</span>&#160; <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> Internal_FindFile(</div><div class="line"><a name="l01546"></a><span class="lineno"> 1546</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* base_path,</div><div class="line"><a name="l01547"></a><span class="lineno"> 1547</span>&#160; <span class="keywordtype">bool</span> bBasePathIncludesFileName,</div><div class="line"><a name="l01548"></a><span class="lineno"> 1548</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a>* file_preference,</div><div class="line"><a name="l01549"></a><span class="lineno"> 1549</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> file_preference_count,</div><div class="line"><a name="l01550"></a><span class="lineno"> 1550</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>&amp; found_file_full_path,</div><div class="line"><a name="l01551"></a><span class="lineno"> 1551</span>&#160; <a class="code" href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a>* found_file_content_hash</div><div class="line"><a name="l01552"></a><span class="lineno"> 1552</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l01553"></a><span class="lineno"> 1553</span>&#160;};</div><div class="line"><a name="l01554"></a><span class="lineno"> 1554</span>&#160;</div><div class="line"><a name="l01555"></a><span class="lineno"> 1555</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l01556"></a><span class="lineno"> 1556</span>&#160;<span class="comment">Description:</span></div><div class="line"><a name="l01557"></a><span class="lineno"> 1557</span>&#160;<span class="comment"> Iterates through every item in a file system directory.</span></div><div class="line"><a name="l01558"></a><span class="lineno"> 1558</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l01559"></a><span class="lineno"> 1559</span>&#160;<span class="keyword">class </span>ON_CLASS <a class="code" href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a></div><div class="line"><a name="l01560"></a><span class="lineno"> 1560</span>&#160;{</div><div class="line"><a name="l01561"></a><span class="lineno"> 1561</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l01562"></a><span class="lineno"> 1562</span>&#160; <a class="code" href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l01563"></a><span class="lineno"> 1563</span>&#160; ~<a class="code" href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a>();</div><div class="line"><a name="l01564"></a><span class="lineno"> 1564</span>&#160;</div><div class="line"><a name="l01565"></a><span class="lineno"> 1565</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l01566"></a><span class="lineno"> 1566</span>&#160; <a class="code" href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a>(<span class="keyword">const</span> <a class="code" href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l01567"></a><span class="lineno"> 1567</span>&#160; <a class="code" href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l01568"></a><span class="lineno"> 1568</span>&#160;</div><div class="line"><a name="l01569"></a><span class="lineno"> 1569</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l01570"></a><span class="lineno"> 1570</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01571"></a><span class="lineno"> 1571</span>&#160;<span class="comment"> //////////////////////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l01572"></a><span class="lineno"> 1572</span>&#160;<span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l01573"></a><span class="lineno"> 1573</span>&#160; <span class="comment">// Iteratation initialization tools</span></div><div class="line"><a name="l01574"></a><span class="lineno"> 1574</span>&#160; <span class="comment">//</span></div><div class="line"><a name="l01575"></a><span class="lineno"> 1575</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01576"></a><span class="lineno"> 1576</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01577"></a><span class="lineno"> 1577</span>&#160;<span class="comment"> Initialize where the search should occur.</span></div><div class="line"><a name="l01578"></a><span class="lineno"> 1578</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l01579"></a><span class="lineno"> 1579</span>&#160;<span class="comment"> directory_name - [in]</span></div><div class="line"><a name="l01580"></a><span class="lineno"> 1580</span>&#160;<span class="comment"> The directory to look in.</span></div><div class="line"><a name="l01581"></a><span class="lineno"> 1581</span>&#160;<span class="comment"> item_name_filter - [in]</span></div><div class="line"><a name="l01582"></a><span class="lineno"> 1582</span>&#160;<span class="comment"> If this paramter is null, then the iteration</span></div><div class="line"><a name="l01583"></a><span class="lineno"> 1583</span>&#160;<span class="comment"> includes all names in the directory.</span></div><div class="line"><a name="l01584"></a><span class="lineno"> 1584</span>&#160;<span class="comment"> The item name to search for. This parameter can </span></div><div class="line"><a name="l01585"></a><span class="lineno"> 1585</span>&#160;<span class="comment"> include wildcard characters, such as an</span></div><div class="line"><a name="l01586"></a><span class="lineno"> 1586</span>&#160;<span class="comment"> asterisk (*) or a question mark (?). For example,</span></div><div class="line"><a name="l01587"></a><span class="lineno"> 1587</span>&#160;<span class="comment"> &quot;\rootdir\subdir\*.*&quot; will iterate all files in</span></div><div class="line"><a name="l01588"></a><span class="lineno"> 1588</span>&#160;<span class="comment"> the \rootdir\subdir\ directory.</span></div><div class="line"><a name="l01589"></a><span class="lineno"> 1589</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01590"></a><span class="lineno"> 1590</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01591"></a><span class="lineno"> 1591</span>&#160;<span class="comment"> true:</span></div><div class="line"><a name="l01592"></a><span class="lineno"> 1592</span>&#160;<span class="comment"> The iterator is set to the first item.</span></div><div class="line"><a name="l01593"></a><span class="lineno"> 1593</span>&#160;<span class="comment"> false:</span></div><div class="line"><a name="l01594"></a><span class="lineno"> 1594</span>&#160;<span class="comment"> There are no matching items.</span></div><div class="line"><a name="l01595"></a><span class="lineno"> 1595</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01596"></a><span class="lineno"> 1596</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l01597"></a><span class="lineno"> 1597</span>&#160;<span class="comment"> Calling FirstItem() is eqivalent to calling Initialize() and then calling NextItem().</span></div><div class="line"><a name="l01598"></a><span class="lineno"> 1598</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01599"></a><span class="lineno"> 1599</span>&#160; <span class="keywordtype">bool</span> Initialize( </div><div class="line"><a name="l01600"></a><span class="lineno"> 1600</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* directory_name</div><div class="line"><a name="l01601"></a><span class="lineno"> 1601</span>&#160; );</div><div class="line"><a name="l01602"></a><span class="lineno"> 1602</span>&#160; <span class="keywordtype">bool</span> Initialize( </div><div class="line"><a name="l01603"></a><span class="lineno"> 1603</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* directory_name, </div><div class="line"><a name="l01604"></a><span class="lineno"> 1604</span>&#160; <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* item_name_filter</div><div class="line"><a name="l01605"></a><span class="lineno"> 1605</span>&#160; );</div><div class="line"><a name="l01606"></a><span class="lineno"> 1606</span>&#160; <span class="keywordtype">bool</span> Initialize( </div><div class="line"><a name="l01607"></a><span class="lineno"> 1607</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* directory_name</div><div class="line"><a name="l01608"></a><span class="lineno"> 1608</span>&#160; );</div><div class="line"><a name="l01609"></a><span class="lineno"> 1609</span>&#160; <span class="keywordtype">bool</span> Initialize( </div><div class="line"><a name="l01610"></a><span class="lineno"> 1610</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* directory_name, </div><div class="line"><a name="l01611"></a><span class="lineno"> 1611</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* item_name_filter</div><div class="line"><a name="l01612"></a><span class="lineno"> 1612</span>&#160; );</div><div class="line"><a name="l01613"></a><span class="lineno"> 1613</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01614"></a><span class="lineno"> 1614</span>&#160;<span class="comment"> //////////////////////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l01615"></a><span class="lineno"> 1615</span>&#160;<span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l01616"></a><span class="lineno"> 1616</span>&#160; <span class="comment">// Iteratation iteration tools</span></div><div class="line"><a name="l01617"></a><span class="lineno"> 1617</span>&#160; <span class="comment">//</span></div><div class="line"><a name="l01618"></a><span class="lineno"> 1618</span>&#160;</div><div class="line"><a name="l01619"></a><span class="lineno"> 1619</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01620"></a><span class="lineno"> 1620</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01621"></a><span class="lineno"> 1621</span>&#160;<span class="comment"> Find the first matching item in the directory.</span></div><div class="line"><a name="l01622"></a><span class="lineno"> 1622</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l01623"></a><span class="lineno"> 1623</span>&#160;<span class="comment"> // Iterate through the files in a directory named &quot;\rootdir\subdir&quot;</span></div><div class="line"><a name="l01624"></a><span class="lineno"> 1624</span>&#160;<span class="comment"> ON_FileIterator fit;</span></div><div class="line"><a name="l01625"></a><span class="lineno"> 1625</span>&#160;<span class="comment"> fit.Initialize(&quot;\\rootdir\\subdir&quot;);</span></div><div class="line"><a name="l01626"></a><span class="lineno"> 1626</span>&#160;<span class="comment"> for ( bool bHaveItem = fit.FirstItem(); bHaveItem; bHaveItem = fit.NextItem() )</span></div><div class="line"><a name="l01627"></a><span class="lineno"> 1627</span>&#160;<span class="comment"> {</span></div><div class="line"><a name="l01628"></a><span class="lineno"> 1628</span>&#160;<span class="comment"> if ( fit.CurrentFileIsDirectory() )</span></div><div class="line"><a name="l01629"></a><span class="lineno"> 1629</span>&#160;<span class="comment"> continue;</span></div><div class="line"><a name="l01630"></a><span class="lineno"> 1630</span>&#160;<span class="comment"> ON_String fullpath = fit.CurrentItemFullPathName();</span></div><div class="line"><a name="l01631"></a><span class="lineno"> 1631</span>&#160;<span class="comment"> FILE* fp = ON_FileStream::Open(fullpath,&quot;rb&quot;);</span></div><div class="line"><a name="l01632"></a><span class="lineno"> 1632</span>&#160;<span class="comment"> if ( 0 == fp )</span></div><div class="line"><a name="l01633"></a><span class="lineno"> 1633</span>&#160;<span class="comment"> {</span></div><div class="line"><a name="l01634"></a><span class="lineno"> 1634</span>&#160;<span class="comment"> continue;</span></div><div class="line"><a name="l01635"></a><span class="lineno"> 1635</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l01636"></a><span class="lineno"> 1636</span>&#160;<span class="comment"> ...</span></div><div class="line"><a name="l01637"></a><span class="lineno"> 1637</span>&#160;<span class="comment"> ON_FileStream::Close(fp);</span></div><div class="line"><a name="l01638"></a><span class="lineno"> 1638</span>&#160;<span class="comment"> fp = 0;</span></div><div class="line"><a name="l01639"></a><span class="lineno"> 1639</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l01640"></a><span class="lineno"> 1640</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l01641"></a><span class="lineno"> 1641</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01642"></a><span class="lineno"> 1642</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01643"></a><span class="lineno"> 1643</span>&#160;<span class="comment"> true:</span></div><div class="line"><a name="l01644"></a><span class="lineno"> 1644</span>&#160;<span class="comment"> The iterator is set to the first item.</span></div><div class="line"><a name="l01645"></a><span class="lineno"> 1645</span>&#160;<span class="comment"> false:</span></div><div class="line"><a name="l01646"></a><span class="lineno"> 1646</span>&#160;<span class="comment"> There are no matching items.</span></div><div class="line"><a name="l01647"></a><span class="lineno"> 1647</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01648"></a><span class="lineno"> 1648</span>&#160; <span class="keywordtype">bool</span> FirstItem(); </div><div class="line"><a name="l01649"></a><span class="lineno"> 1649</span>&#160;</div><div class="line"><a name="l01650"></a><span class="lineno"> 1650</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01651"></a><span class="lineno"> 1651</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01652"></a><span class="lineno"> 1652</span>&#160;<span class="comment"> Find the next matching item in the directory.</span></div><div class="line"><a name="l01653"></a><span class="lineno"> 1653</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01654"></a><span class="lineno"> 1654</span>&#160;<span class="comment"> true:</span></div><div class="line"><a name="l01655"></a><span class="lineno"> 1655</span>&#160;<span class="comment"> The iterator was advanced to the next item.</span></div><div class="line"><a name="l01656"></a><span class="lineno"> 1656</span>&#160;<span class="comment"> false:</span></div><div class="line"><a name="l01657"></a><span class="lineno"> 1657</span>&#160;<span class="comment"> There are no more matching items.</span></div><div class="line"><a name="l01658"></a><span class="lineno"> 1658</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01659"></a><span class="lineno"> 1659</span>&#160; <span class="keywordtype">bool</span> NextItem();</div><div class="line"><a name="l01660"></a><span class="lineno"> 1660</span>&#160;</div><div class="line"><a name="l01661"></a><span class="lineno"> 1661</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01662"></a><span class="lineno"> 1662</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l01663"></a><span class="lineno"> 1663</span>&#160;<span class="comment"> Reset this ON_FileIterator so it can be used again.</span></div><div class="line"><a name="l01664"></a><span class="lineno"> 1664</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01665"></a><span class="lineno"> 1665</span>&#160; <span class="keywordtype">void</span> Reset();</div><div class="line"><a name="l01666"></a><span class="lineno"> 1666</span>&#160;<span class="comment"></span></div><div class="line"><a name="l01667"></a><span class="lineno"> 1667</span>&#160;<span class="comment"> //////////////////////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l01668"></a><span class="lineno"> 1668</span>&#160;<span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l01669"></a><span class="lineno"> 1669</span>&#160; <span class="comment">// Current item query</span></div><div class="line"><a name="l01670"></a><span class="lineno"> 1670</span>&#160; <span class="comment">//</span></div><div class="line"><a name="l01671"></a><span class="lineno"> 1671</span>&#160;</div><div class="line"><a name="l01672"></a><span class="lineno"> 1672</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01673"></a><span class="lineno"> 1673</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01674"></a><span class="lineno"> 1674</span>&#160;<span class="comment"> Current file or directory name in the directory being iterated.</span></div><div class="line"><a name="l01675"></a><span class="lineno"> 1675</span>&#160;<span class="comment"> Use CurrentFullPathItemName() to get the full path name.</span></div><div class="line"><a name="l01676"></a><span class="lineno"> 1676</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01677"></a><span class="lineno"> 1677</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> CurrentItemName() <span class="keyword">const</span>;</div><div class="line"><a name="l01678"></a><span class="lineno"> 1678</span>&#160;</div><div class="line"><a name="l01679"></a><span class="lineno"> 1679</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01680"></a><span class="lineno"> 1680</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01681"></a><span class="lineno"> 1681</span>&#160;<span class="comment"> The name of the directory being iterated.</span></div><div class="line"><a name="l01682"></a><span class="lineno"> 1682</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01683"></a><span class="lineno"> 1683</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> DirectoryName() <span class="keyword">const</span>;</div><div class="line"><a name="l01684"></a><span class="lineno"> 1684</span>&#160;</div><div class="line"><a name="l01685"></a><span class="lineno"> 1685</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01686"></a><span class="lineno"> 1686</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01687"></a><span class="lineno"> 1687</span>&#160;<span class="comment"> If the current item is a file, then the size of the file in bytes is returned.</span></div><div class="line"><a name="l01688"></a><span class="lineno"> 1688</span>&#160;<span class="comment"> If the current item is a directory, then 0 is returned.</span></div><div class="line"><a name="l01689"></a><span class="lineno"> 1689</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01690"></a><span class="lineno"> 1690</span>&#160; ON__UINT64 CurrentItemSize() <span class="keyword">const</span>;</div><div class="line"><a name="l01691"></a><span class="lineno"> 1691</span>&#160;</div><div class="line"><a name="l01692"></a><span class="lineno"> 1692</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01693"></a><span class="lineno"> 1693</span>&#160;<span class="comment"> Returns </span></div><div class="line"><a name="l01694"></a><span class="lineno"> 1694</span>&#160;<span class="comment"> true if the current item is a directory.</span></div><div class="line"><a name="l01695"></a><span class="lineno"> 1695</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01696"></a><span class="lineno"> 1696</span>&#160; <span class="keywordtype">bool</span> CurrentItemIsDirectory() <span class="keyword">const</span>;</div><div class="line"><a name="l01697"></a><span class="lineno"> 1697</span>&#160;</div><div class="line"><a name="l01698"></a><span class="lineno"> 1698</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01699"></a><span class="lineno"> 1699</span>&#160;<span class="comment"> Returns </span></div><div class="line"><a name="l01700"></a><span class="lineno"> 1700</span>&#160;<span class="comment"> true if the current item is a file.</span></div><div class="line"><a name="l01701"></a><span class="lineno"> 1701</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01702"></a><span class="lineno"> 1702</span>&#160; <span class="keywordtype">bool</span> CurrentItemIsFile() <span class="keyword">const</span>;</div><div class="line"><a name="l01703"></a><span class="lineno"> 1703</span>&#160;</div><div class="line"><a name="l01704"></a><span class="lineno"> 1704</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01705"></a><span class="lineno"> 1705</span>&#160;<span class="comment"> Returns </span></div><div class="line"><a name="l01706"></a><span class="lineno"> 1706</span>&#160;<span class="comment"> true if the current file or directory is hidden.</span></div><div class="line"><a name="l01707"></a><span class="lineno"> 1707</span>&#160;<span class="comment"> This means its name begins with a &#39;.&#39; or it&#39;s</span></div><div class="line"><a name="l01708"></a><span class="lineno"> 1708</span>&#160;<span class="comment"> Windows hidden attribute is true.</span></div><div class="line"><a name="l01709"></a><span class="lineno"> 1709</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01710"></a><span class="lineno"> 1710</span>&#160; <span class="keywordtype">bool</span> CurrentItemIsHidden() <span class="keyword">const</span>;</div><div class="line"><a name="l01711"></a><span class="lineno"> 1711</span>&#160;</div><div class="line"><a name="l01712"></a><span class="lineno"> 1712</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> CurrentItemFullPathName() <span class="keyword">const</span>;</div><div class="line"><a name="l01713"></a><span class="lineno"> 1713</span>&#160;</div><div class="line"><a name="l01714"></a><span class="lineno"> 1714</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01715"></a><span class="lineno"> 1715</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01716"></a><span class="lineno"> 1716</span>&#160;<span class="comment"> File last modified time in seconds since January 1, 1970</span></div><div class="line"><a name="l01717"></a><span class="lineno"> 1717</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l01718"></a><span class="lineno"> 1718</span>&#160;<span class="comment"> The times returned by ON_FileIterator can differ from the time</span></div><div class="line"><a name="l01719"></a><span class="lineno"> 1719</span>&#160;<span class="comment"> returned by ON_FileStream::GetFileInformation().</span></div><div class="line"><a name="l01720"></a><span class="lineno"> 1720</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01721"></a><span class="lineno"> 1721</span>&#160; ON__UINT64 CurrentItemLastModifiedTime() <span class="keyword">const</span>;</div><div class="line"><a name="l01722"></a><span class="lineno"> 1722</span>&#160;</div><div class="line"><a name="l01723"></a><span class="lineno"> 1723</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l01724"></a><span class="lineno"> 1724</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l01725"></a><span class="lineno"> 1725</span>&#160;<span class="comment"> Number of matching items iterated through.</span></div><div class="line"><a name="l01726"></a><span class="lineno"> 1726</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l01727"></a><span class="lineno"> 1727</span>&#160; ON__UINT64 CurrentItemCount() <span class="keyword">const</span>;</div><div class="line"><a name="l01728"></a><span class="lineno"> 1728</span>&#160;</div><div class="line"><a name="l01729"></a><span class="lineno"> 1729</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l01730"></a><span class="lineno"> 1730</span>&#160; ON__UINT32 m_state = 0; <span class="comment">// 0 unset, 1=initialized, 2 = itereation in progress. 3 = iteration finished.</span></div><div class="line"><a name="l01731"></a><span class="lineno"> 1731</span>&#160; ON__UINT32 m_reserved = 0;</div><div class="line"><a name="l01732"></a><span class="lineno"> 1732</span>&#160;</div><div class="line"><a name="l01733"></a><span class="lineno"> 1733</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> m_directory; <span class="comment">// directory passed to Initialize() or FirstItem</span></div><div class="line"><a name="l01734"></a><span class="lineno"> 1734</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> m_item_name_filter; <span class="comment">// item_name_filter passed to Initialize() or FirstItem</span></div><div class="line"><a name="l01735"></a><span class="lineno"> 1735</span>&#160; <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> m_item_name; <span class="comment">// Current item name.</span></div><div class="line"><a name="l01736"></a><span class="lineno"> 1736</span>&#160;</div><div class="line"><a name="l01737"></a><span class="lineno"> 1737</span>&#160; <span class="comment">// cached full path name </span></div><div class="line"><a name="l01738"></a><span class="lineno"> 1738</span>&#160; <span class="comment">// m_directory + directory separator + m_item_name</span></div><div class="line"><a name="l01739"></a><span class="lineno"> 1739</span>&#160; <span class="comment">// (length = 0 if it is not set)</span></div><div class="line"><a name="l01740"></a><span class="lineno"> 1740</span>&#160; <span class="keyword">mutable</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> m_full_path_name;</div><div class="line"><a name="l01741"></a><span class="lineno"> 1741</span>&#160;</div><div class="line"><a name="l01742"></a><span class="lineno"> 1742</span>&#160; ON__UINT64 m_count = 0; <span class="comment">// number of items iterated through so far</span></div><div class="line"><a name="l01743"></a><span class="lineno"> 1743</span>&#160; <span class="keyword">class </span>ON_DirectoryIteratorImpl* m_impl = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l01744"></a><span class="lineno"> 1744</span>&#160;};</div><div class="line"><a name="l01745"></a><span class="lineno"> 1745</span>&#160;</div><div class="line"><a name="l01746"></a><span class="lineno"> 1746</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="class_o_n___file_system_path_html_ae6a9483116ab6d025cfdf11161e19485"><div class="ttname"><a href="../../d1/d6e/class_o_n___file_system_path.html#ae6a9483116ab6d025cfdf11161e19485">ON_FileSystemPath::PathId</a></div><div class="ttdeci">PathId</div><div class="ttdoc">ids used by ON_FileSystemPath::GetPath() </div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:511</div></div>
<div class="ttc" id="struct_o_n___u_u_i_d__struct_html"><div class="ttname"><a href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID_struct</a></div><div class="ttdoc">ON_UUID is a 16 byte universally unique identifier. </div><div class="ttdef"><b>Definition:</b> opennurbs_uuid.h:32</div></div>
<div class="ttc" id="class_o_n___s_h_a1___hash_html_a5fbd8257f1b9c3fdfc929d3869113924"><div class="ttname"><a href="../../dd/ddf/class_o_n___s_h_a1___hash.html#a5fbd8257f1b9c3fdfc929d3869113924">ON_SHA1_Hash::EmptyContentHash</a></div><div class="ttdeci">static const ON_SHA1_Hash EmptyContentHash</div><div class="ttdef"><b>Definition:</b> opennurbs_sha1.h:23</div></div>
<div class="ttc" id="class_o_n___s_h_a1___hash_html"><div class="ttname"><a href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a></div><div class="ttdef"><b>Definition:</b> opennurbs_sha1.h:19</div></div>
<div class="ttc" id="class_o_n__w_string_html"><div class="ttname"><a href="../../d1/d11/class_o_n__w_string.html">ON_wString</a></div><div class="ttdef"><b>Definition:</b> opennurbs_string.h:2020</div></div>
<div class="ttc" id="class_o_n___file_reference_html_a65c239486e5d0a0f20c8fa2d0b61d876"><div class="ttname"><a href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a></div><div class="ttdeci">FindFilePreference</div><div class="ttdoc">Defines options for file search.</div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:1180</div></div>
<div class="ttc" id="class_o_n___file_system_html"><div class="ttname"><a href="../../db/d70/class_o_n___file_system.html">ON_FileSystem</a></div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:19</div></div>
<div class="ttc" id="class_o_n___string_html"><div class="ttname"><a href="../../d2/d3b/class_o_n___string.html">ON_String</a></div><div class="ttdef"><b>Definition:</b> opennurbs_string.h:852</div></div>
<div class="ttc" id="class_o_n___file_stream_html"><div class="ttname"><a href="../../dd/da7/class_o_n___file_stream.html">ON_FileStream</a></div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:561</div></div>
<div class="ttc" id="class_o_n___content_hash_html"><div class="ttname"><a href="../../db/d13/class_o_n___content_hash.html">ON_ContentHash</a></div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:762</div></div>
<div class="ttc" id="class_o_n___file_reference_html_ae6dad3944d37be0da31bc0504cc71b46"><div class="ttname"><a href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">ON_FileReference::Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">Enumerates a list of file statuses.</div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:1132</div></div>
<div class="ttc" id="class_o_n___content_hash_html_a5a6e077d6893727a93e91d3f1c9e847d"><div class="ttname"><a href="../../db/d13/class_o_n___content_hash.html#a5a6e077d6893727a93e91d3f1c9e847d">ON_ContentHash::CompareResult</a></div><div class="ttdeci">CompareResult</div><div class="ttdoc">ON_ContentHash::Compare are the possible results of calling ON_ContentHash::CompareFile(). </div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:960</div></div>
<div class="ttc" id="class_o_n___text_log_html"><div class="ttname"><a href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a></div><div class="ttdef"><b>Definition:</b> opennurbs_textlog.h:20</div></div>
<div class="ttc" id="class_o_n___binary_archive_html"><div class="ttname"><a href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a></div><div class="ttdef"><b>Definition:</b> opennurbs_archive.h:1783</div></div>
<div class="ttc" id="class_o_n___file_reference_html_ae6dad3944d37be0da31bc0504cc71b46a88183b946cc5f0e8c96b2e66e1c74a7e"><div class="ttname"><a href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46a88183b946cc5f0e8c96b2e66e1c74a7e">ON_FileReference::Status::Unknown</a></div><div class="ttdoc">Status of a the full path is not known. </div></div>
<div class="ttc" id="class_o_n___s_h_a1___hash_html_a50683fde45600ba340667429fd8fd686"><div class="ttname"><a href="../../dd/ddf/class_o_n___s_h_a1___hash.html#a50683fde45600ba340667429fd8fd686">ON_SHA1_Hash::ZeroDigest</a></div><div class="ttdeci">static const ON_SHA1_Hash ZeroDigest</div><div class="ttdef"><b>Definition:</b> opennurbs_sha1.h:22</div></div>
<div class="ttc" id="class_o_n___file_system_path_html"><div class="ttname"><a href="../../d1/d6e/class_o_n___file_system_path.html">ON_FileSystemPath</a></div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:109</div></div>
<div class="ttc" id="class_o_n___file_iterator_html"><div class="ttname"><a href="../../d5/db7/class_o_n___file_iterator.html">ON_FileIterator</a></div><div class="ttdoc">Iterates through every item in a file system directory. </div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:1480</div></div>
<div class="ttc" id="class_o_n___file_reference_html"><div class="ttname"><a href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a></div><div class="ttdef"><b>Definition:</b> opennurbs_file_utilities.h:1125</div></div>
</div><!-- fragment --></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:26 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