lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-04-17 19:56:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Publish!

Browse Source 
Generated from v6.0.11315.11111-test13
This commit is contained in:
Bozo
2018-02-02 07:57:49 -08:00
parent db96b72945
commit 9af473956f
957 changed files with 32952 additions and 16598 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
6/d8/dfd/class_o_n___file_reference.html
View File

@@ -66,12 +66,14 @@ Public Types</h2></td></tr>
&#160;&#160;<a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876a62a4bf2ac127904c3cb8807becd0ed23">FindFilePreference::ContentMatch</a> = 4,
<a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876a1f7eef9de38738e79be7905c6067c98f">FindFilePreference::MostRecent</a> = 5
<br />
}</td></tr>
}<tr class="memdesc:a65c239486e5d0a0f20c8fa2d0b61d876"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines options for file search. <a href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a65c239486e5d0a0f20c8fa2d0b61d876"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6dad3944d37be0da31bc0504cc71b46"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">Status</a> : unsigned int { <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46a88183b946cc5f0e8c96b2e66e1c74a7e">Status::Unknown</a> = 0,
<a class="el" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46a97b1650b042da84918df0492b2c8652b">Status::FullPathValid</a> = 1,
<a class="el" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46a2767828026039e8ba7b38973cbb701f2">Status::FileNotFound</a> = 2
}</td></tr>
}<tr class="memdesc:ae6dad3944d37be0da31bc0504cc71b46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumerates a list of file statuses. <a href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ae6dad3944d37be0da31bc0504cc71b46"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
@@ -97,12 +99,16 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a4ef48df427d6903f5b0ff03de44093e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a4ef48df427d6903f5b0ff03de44093e0">EmbeddedFileId</a> () const</td></tr>
<tr class="separator:a4ef48df427d6903f5b0ff03de44093e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b7165105a647c45cd9f23b3a0034037"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a2b7165105a647c45cd9f23b3a0034037">FindFile</a> (const wchar_t *base_path, bool bBasePathIncludesFileName, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> first_choice, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> second_choice, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> third_choice, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> forth_choice, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> fifth_choice, <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;found_file_full_path) const</td></tr>
<tr class="memdesc:a2b7165105a647c45cd9f23b3a0034037"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uses the full path, relative path and parameter information to find a full path to a file that exists. <a href="#a2b7165105a647c45cd9f23b3a0034037">More...</a><br /></td></tr>
<tr class="separator:a2b7165105a647c45cd9f23b3a0034037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafce0c134a210a12482c0234e69fcdab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#aafce0c134a210a12482c0234e69fcdab">FindFile</a> (const wchar_t *base_path, bool bBasePathIncludesFileName, <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;found_file_full_path) const</td></tr>
<tr class="memdesc:aafce0c134a210a12482c0234e69fcdab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uses the full path, relative path and parameter information to find a full path to a file that exists. <a href="#aafce0c134a210a12482c0234e69fcdab">More...</a><br /></td></tr>
<tr class="separator:aafce0c134a210a12482c0234e69fcdab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8057154c24fc698384cf9487d6fa5a12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a8057154c24fc698384cf9487d6fa5a12">FindFileAndUpdateReference</a> (const wchar_t *base_path, bool bBasePathIncludesFileName, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> first_choice, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> second_choice, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> third_choice, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> forth_choice, <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> fifth_choice, bool bUpdateContentHash, <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;found_file_full_path)</td></tr>
<tr class="memdesc:a8057154c24fc698384cf9487d6fa5a12"><td class="mdescLeft">&#160;</td><td class="mdescRight">The search for the file is identical to the one performed by find file. If a file is found, the full path setting in this reference is updated. <a href="#a8057154c24fc698384cf9487d6fa5a12">More...</a><br /></td></tr>
<tr class="separator:a8057154c24fc698384cf9487d6fa5a12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2307bf8d791e91f809f6bc15d9b1e576"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a2307bf8d791e91f809f6bc15d9b1e576">FindFileAndUpdateReference</a> (const wchar_t *base_path, bool bBasePathIncludesFileName, bool bUpdateContentHash, <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;found_file_full_path)</td></tr>
<tr class="memdesc:a2307bf8d791e91f809f6bc15d9b1e576"><td class="mdescLeft">&#160;</td><td class="mdescRight">The search for the file is identical to the one performed by find file. If a file is found, the full path setting in this reference is updated. <a href="#a2307bf8d791e91f809f6bc15d9b1e576">More...</a><br /></td></tr>
<tr class="separator:a2307bf8d791e91f809f6bc15d9b1e576"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0276affb2d7f5a87cd3d2f52d6f004e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#af0276affb2d7f5a87cd3d2f52d6f004e">FindFileAndUpdateReference</a> (const wchar_t *base_path, bool bBasePathIncludesFileName, bool bUpdateContentHash)</td></tr>
<tr class="separator:af0276affb2d7f5a87cd3d2f52d6f004e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -160,7 +166,6 @@ Static Public Member Functions</h2></td></tr>
<tr class="memitem:a6b371b2180d486d4e1ee63efdeee2cc0"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a6b371b2180d486d4e1ee63efdeee2cc0">Compare</a> (const <a class="el" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a> &amp;a, const <a class="el" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a> &amp;b)</td></tr>
<tr class="separator:a6b371b2180d486d4e1ee63efdeee2cc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65058ad0e91810cdf58e6bd4f0dd950f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65058ad0e91810cdf58e6bd4f0dd950f">CreateFromFullPath</a> (const wchar_t *full_path, bool bSetContentHash, bool bSetFullPathStatus)</td></tr>
<tr class="memdesc:a65058ad0e91810cdf58e6bd4f0dd950f"><td class="mdescLeft">&#160;</td><td class="mdescRight">summary&gt;Defines options for file search. <a href="#a65058ad0e91810cdf58e6bd4f0dd950f">More...</a><br /></td></tr>
<tr class="separator:a65058ad0e91810cdf58e6bd4f0dd950f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abddd0e188e40d1d7b97acf503c553428"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46">ON_FileReference::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#abddd0e188e40d1d7b97acf503c553428">StatusFromUnsigned</a> (unsigned int full_path_status_as_unsigned)</td></tr>
<tr class="separator:abddd0e188e40d1d7b97acf503c553428"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -168,7 +173,6 @@ Static Public Member Functions</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a06f1799b2ed593bd0f8c9270a9719ec2"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="../../d8/dfd/class_o_n___file_reference.html">ON_FileReference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a06f1799b2ed593bd0f8c9270a9719ec2">Unset</a></td></tr>
<tr class="memdesc:a06f1799b2ed593bd0f8c9270a9719ec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">summary&gt;Enumerates a list of file statuses. <a href="#a06f1799b2ed593bd0f8c9270a9719ec2">More...</a><br /></td></tr>
<tr class="separator:a06f1799b2ed593bd0f8c9270a9719ec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
@@ -191,19 +195,21 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Defines options for file search.</p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a6adf97f83acf6453d4a6a4b1070f3754"></a>None&#160;</td><td class="fielddoc"><p>summary&gt;The choice is not defined.</p>
<p>summary&gt;File name exists in <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a>.</p>
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a6adf97f83acf6453d4a6a4b1070f3754"></a>None&#160;</td><td class="fielddoc"><p>The choice is not defined.</p>
</td></tr>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a5aa4e1715e32bca15d81bdbccb759ff5"></a>FullPath&#160;</td><td class="fielddoc"><p>summary&gt;File name exists in base path + <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a>.</p>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a5aa4e1715e32bca15d81bdbccb759ff5"></a>FullPath&#160;</td><td class="fielddoc"><p>File name exists in <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a>.</p>
</td></tr>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a50d72a7b6a8baa24bcdbf5d0334c4897"></a>RelativePath&#160;</td><td class="fielddoc"><p>summary&gt;File name exists in base path directory.</p>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a50d72a7b6a8baa24bcdbf5d0334c4897"></a>RelativePath&#160;</td><td class="fielddoc"><p>File name exists in base path + <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a>.</p>
</td></tr>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a6edb6742a69b12bb2bc426939049f2b6"></a>BasePath&#160;</td><td class="fielddoc"><p>summary&gt;File with mathing content exists.</p>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a6edb6742a69b12bb2bc426939049f2b6"></a>BasePath&#160;</td><td class="fielddoc"><p>File name exists in base path directory.</p>
</td></tr>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a62a4bf2ac127904c3cb8807becd0ed23"></a>ContentMatch&#160;</td><td class="fielddoc"><p>summary&gt;Most recently modifed file.</p>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a62a4bf2ac127904c3cb8807becd0ed23"></a>ContentMatch&#160;</td><td class="fielddoc"><p>File with mathing content exists.</p>
</td></tr>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a1f7eef9de38738e79be7905c6067c98f"></a>MostRecent&#160;</td><td class="fielddoc"><p>Most recently modifed file.</p>
</td></tr>
<tr><td class="fieldname"><a id="a65c239486e5d0a0f20c8fa2d0b61d876a1f7eef9de38738e79be7905c6067c98f"></a>MostRecent&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
@@ -227,6 +233,8 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Enumerates a list of file statuses.</p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae6dad3944d37be0da31bc0504cc71b46a88183b946cc5f0e8c96b2e66e1c74a7e"></a>Unknown&#160;</td><td class="fielddoc"><p>Status of a the full path is not known. </p>
</td></tr>
@@ -457,7 +465,7 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: File content hash. This value is persistent, saved in 3dm archive, and could have been calculated a long time ago on a different computer. </p>
<dl class="section return"><dt>Returns</dt><dd>File content hash. This value is persistent, saved in 3dm archive, and could have been calculated a long time ago on a different computer. </dd></dl>
</div>
</div>
@@ -501,8 +509,6 @@ Static Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>summary&gt;Defines options for file search.</p>
</div>
</div>
<a id="a3ac0e34ccb03c4c99453e8c3956ee601"></a>
@@ -601,7 +607,23 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Uses the full path, relative path and parameter information to find a full path to a file that exists. Parameters: base_path - [in] If base_path and <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a> are not empty, then path base_path+RelativePath(). If base_path is not empty, then base_path + filename is considered. bBasePathIncludesFileName - [in] True if base_path contains a file name that must be removed to get a directory path. first_choice - [in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned. second_choice - [in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned. third_choice - [in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned. forth_choice - [in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned. fifth_choice - [in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned. full_path - [out] A full path to a file that exists. If <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a> and base_path+RelativePath() resolve to different files, the content hash information is used to select the file. Returns: If the file is found, then the returned <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> enum value indicates why it was selected. If the file is not found, then <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876a6adf97f83acf6453d4a6a4b1070f3754" title="summary&gt;The choice is not defined.">ON_FileReference::FindFilePreference::None</a> is returned and full_path is empty. Remarks: The locations <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a>, base_path+RelativePath(), and base_path+FileName() are tested. If multiple files are found, first_choice, second_choice, third_choice, forth_choice, and fifth_choice are used to select which file is returned. </p>
<p>Uses the full path, relative path and parameter information to find a full path to a file that exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base_path</td><td>[in] If base_path and <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a> are not empty, then path base_path+RelativePath(). If base_path is not empty, then base_path + filename is considered.</td></tr>
<tr><td class="paramname">bBasePathIncludesFileName</td><td>[in] True if base_path contains a file name that must be removed to get a directory path.</td></tr>
<tr><td class="paramname">first_choice</td><td>[in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned.</td></tr>
<tr><td class="paramname">second_choice</td><td>[in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned.</td></tr>
<tr><td class="paramname">third_choice</td><td>[in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned.</td></tr>
<tr><td class="paramname">forth_choice</td><td>[in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned.</td></tr>
<tr><td class="paramname">fifth_choice</td><td>[in] When multiple files are found in different locations, the first_choice, second_choice, third_choice, forth_choice, and fifth_choice parameters are used to select which file is returned.</td></tr>
<tr><td class="paramname">full_path</td><td>[out] A full path to a file that exists. If <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a> and base_path+RelativePath() resolve to different files, the content hash information is used to select the file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the file is found, then the returned <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876" title="Defines options for file search.">ON_FileReference::FindFilePreference</a> enum value indicates why it was selected. If the file is not found, then <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876a6adf97f83acf6453d4a6a4b1070f3754" title="The choice is not defined.">ON_FileReference::FindFilePreference::None</a> is returned and full_path is empty. </dd></dl>
<p>The locations <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a>, base_path+RelativePath(), and base_path+FileName() are tested. If multiple files are found, first_choice, second_choice, third_choice, forth_choice, and fifth_choice are used to select which file is returned. </p>
</div>
</div>
@@ -636,7 +658,17 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Uses the full path, relative path and parameter information to find a full path to a file that exists. Parameters: base_path - [in] If base_path and <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a> are not empty, then path base_path+RelativePath(). If base_path is not empty, then base_path + filename is considered. bBasePathIncludesFileName - [in] True if base_path contains a file name that must be removed to get a directory path. Returns: If the file is found, then the returned <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> enum value indicates why it was selected. If the file is not found, then <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876a6adf97f83acf6453d4a6a4b1070f3754" title="summary&gt;The choice is not defined.">ON_FileReference::FindFilePreference::None</a> is returned and full_path is empty. Remarks: The locations <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a>, base_path+RelativePath(), and base_path+FileName() are tested. If multiple files are found, the returned file is selected in the order relative path, full path, content match, base path and most recently modified. If you prefer a different order, use the version of <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a2b7165105a647c45cd9f23b3a0034037">ON_FileReference::FindFile</a> with 5 <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876">ON_FileReference::FindFilePreference</a> parameters. </p>
<p>Uses the full path, relative path and parameter information to find a full path to a file that exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base_path</td><td>[in] If base_path and <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a> are not empty, then path base_path+RelativePath(). If base_path is not empty, then base_path + filename is considered.</td></tr>
<tr><td class="paramname">bBasePathIncludesFileName</td><td>[in] True if base_path contains a file name that must be removed to get a directory path.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the file is found, then the returned <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876" title="Defines options for file search.">ON_FileReference::FindFilePreference</a> enum value indicates why it was selected. If the file is not found, then <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876a6adf97f83acf6453d4a6a4b1070f3754" title="The choice is not defined.">ON_FileReference::FindFilePreference::None</a> is returned and full_path is empty. </dd></dl>
<p>The locations <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a>, base_path+RelativePath(), and base_path+FileName() are tested. If multiple files are found, the returned file is selected in the order relative path, full path, content match, base path and most recently modified. If you prefer a different order, use the version of <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a2b7165105a647c45cd9f23b3a0034037" title="Uses the full path, relative path and parameter information to find a full path to a file that exists...">ON_FileReference::FindFile</a> with 5 <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a65c239486e5d0a0f20c8fa2d0b61d876" title="Defines options for file search.">ON_FileReference::FindFilePreference</a> parameters. </p>
</div>
</div>
@@ -707,7 +739,8 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: The search for the file is identical to the one performed by find file. If a file is found, the full path setting in this reference is updated. </p>
<p>The search for the file is identical to the one performed by find file. If a file is found, the full path setting in this reference is updated. </p>
</div>
</div>
@@ -748,7 +781,8 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: The search for the file is identical to the one performed by find file. If a file is found, the full path setting in this reference is updated. </p>
<p>The search for the file is identical to the one performed by find file. If a file is found, the full path setting in this reference is updated. </p>
</div>
</div>
@@ -834,7 +868,9 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: ON_SHA1_Hash::FileSystemPathHash(FullPath()); Remarks: The value of the hash is saved in a runtime cache so using this function when comparing paths is efficient when multple compares are required. See Also: ON_NameHash::CreateFilePathHash( ON_FileReference&amp; file_reference ); </p>
<dl class="section return"><dt>Returns</dt><dd>ON_SHA1_Hash::FileSystemPathHash(FullPath()); </dd></dl>
<p>The value of the hash is saved in a runtime cache so using this function when comparing paths is efficient when multple compares are required. </p>
<dl class="section see"><dt>See also</dt><dd>ON_NameHash::CreateFilePathHash( ON_FileReference&amp; file_reference );</dd></dl>
</div>
</div>
@@ -869,7 +905,7 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: True if <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a> is empty. </p>
<dl class="section return"><dt>Returns</dt><dd>True if <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a> is empty. </dd></dl>
</div>
</div>
@@ -887,7 +923,7 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: True if <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a> is not empty. </p>
<dl class="section return"><dt>Returns</dt><dd>True if <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a> is not empty. </dd></dl>
</div>
</div>
@@ -932,7 +968,7 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Remarks: Calling <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a5b93678bf727faa529b68aeb1cbfabe0">Read()</a> sets m_full_path_status = <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46a88183b946cc5f0e8c96b2e66e1c74a7e" title="Status of a the full path is not known. ">ON_FileReference::Status::Unknown</a>, even if that was not the status when <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a21d869fbbea601cbe6b61e71d9a81f58">Write()</a> was called. </p>
<p>Calling <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a5b93678bf727faa529b68aeb1cbfabe0">Read()</a> sets m_full_path_status = <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#ae6dad3944d37be0da31bc0504cc71b46a88183b946cc5f0e8c96b2e66e1c74a7e" title="Status of a the full path is not known. ">ON_FileReference::Status::Unknown</a>, even if that was not the status when <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a21d869fbbea601cbe6b61e71d9a81f58">Write()</a> was called. </p>
</div>
</div>
@@ -951,7 +987,13 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Parameters: recent_time - [in] The time, in number of seconds since January 1, 1970 UTC, to use when deciding what content hashes can be considered recent. If recent_time is 0 or in the future, then the current value of ON_SecondsSinceJanOne1970UTC() is used. Typically this parameter is the value of ON_SecondsSinceJanOne1970UTC() at the beginning of a calculation durint which any referenced files will not be changed. Returns: A file content hash value calculated on or after a specified time in the current instance of the application. This value is used to detect changed files in the current instance of the application. It is cached for performance reasons. This value is never saved in 3dm files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">recent_time</td><td>[in] The time, in number of seconds since January 1, 1970 UTC, to use when deciding what content hashes can be considered recent. If recent_time is 0 or in the future, then the current value of ON_SecondsSinceJanOne1970UTC() is used. Typically this parameter is the value of ON_SecondsSinceJanOne1970UTC() at the beginning of a calculation durint which any referenced files will not be changed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A file content hash value calculated on or after a specified time in the current instance of the application. This value is used to detect changed files in the current instance of the application. It is cached for performance reasons. This value is never saved in 3dm files. </dd></dl>
</div>
</div>
@@ -1276,7 +1318,12 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: bUseArchiveBasePath - [in] If bUseArchiveBasePath is true and a file is being written, then the base path of the file being written use used as the base path to calculate the relative path. If bUseArchiveBasePath is false, then the current value of <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a> is saved in the archive. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bUseArchiveBasePath</td><td>[in] If bUseArchiveBasePath is true and a file is being written, then the base path of the file being written use used as the base path to calculate the relative path. If bUseArchiveBasePath is false, then the current value of <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a> is saved in the archive.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
@@ -1311,7 +1358,12 @@ Static Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: base_path - [in] If base_path is not empty, then the relative path saved in the archive will be calculated from <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a> and base_path. If base_path is nullptr or empty, then <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a> is saved in the archive. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base_path</td><td>[in] If base_path is not empty, then the relative path saved in the archive will be calculated from <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#a3eaf822c1004c7c1d6d5a5897bbd9309">FullPath()</a> and base_path. If base_path is nullptr or empty, then <a class="el" href="../../d8/dfd/class_o_n___file_reference.html#afdf782ac9c7d9a635447f50db50e6119">RelativePath()</a> is saved in the archive.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
@@ -1336,8 +1388,6 @@ Static Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>summary&gt;Enumerates a list of file statuses.</p>
</div>
</div>
</div><!-- contents -->
@@ -1346,7 +1396,7 @@ Static Public Attributes</h2></td></tr>
</div> <!-- page-content -->
</div> <!-- container -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 31 2018 14:45:40 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
Generated on Fri Feb 2 2018 07:57:29 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
Doxygen
</a> 1.8.13