This commit is contained in:
rozmansi
2022-03-07 09:10:54 +00:00
parent c40391b265
commit fa6576c229
318 changed files with 16776 additions and 7341 deletions

View File

@@ -70,46 +70,50 @@ $(function() {
<div class="headertitle"><div class="title">Shell.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<a href="_shell_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 1991-2022 Amebis</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright © 2016 GÉANT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">*/</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;Common.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;Shlwapi.h&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;<a class="code" href="_common_8h.html">Common.h</a>&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &lt;Shlwapi.h&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> _Traits, <span class="keyword">class</span> _Ax&gt;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">static</span> BOOL PathCanonicalizeA(_Inout_ std::basic_string&lt;char, _Traits, _Ax&gt; &amp;sValue, _In_ LPCSTR pszPath)</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> assert(0); <span class="comment">// TODO: Test this code.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// Allocate buffer on heap and read into it.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">char</span> szBuffer[MAX_PATH + 1];</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> BOOL bResult = ::PathCanonicalizeA(szBuffer, pszPath);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> sValue.assign(szBuffer, bResult ? MAX_PATH : 0);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">return</span> bResult;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>}</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> _Traits, <span class="keyword">class</span> _Ax&gt;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">static</span> BOOL PathCanonicalizeW(_Inout_ std::basic_string&lt;wchar_t, _Traits, _Ax&gt; &amp;sValue, _In_ LPCWSTR pszPath)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>{</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> assert(0); <span class="comment">// TODO: Test this code.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">wchar_t</span> szBuffer[MAX_PATH + 1];</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> BOOL bResult = ::PathCanonicalizeW(szBuffer, pszPath);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> sValue.assign(szBuffer, bResult ? MAX_PATH : 0);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">return</span> bResult;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>}</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> _Traits, <span class="keyword">class</span> _Ax&gt;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="group___win_std_shell_w_a_p_i.html#gabc79615c035f76d08ddced61807b6676"> 24</a></span><span class="keyword">static</span> BOOL <a class="code hl_function" href="group___win_std_shell_w_a_p_i.html#gabc79615c035f76d08ddced61807b6676">PathCanonicalizeA</a>(_Inout_ std::basic_string&lt;char, _Traits, _Ax&gt; &amp;sValue, _In_ LPCSTR pszPath)</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> assert(0); <span class="comment">// TODO: Test this code.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Allocate buffer on heap and read into it.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">char</span> szBuffer[MAX_PATH + 1];</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> BOOL bResult = <a class="code hl_function" href="group___win_std_shell_w_a_p_i.html#gabc79615c035f76d08ddced61807b6676">::PathCanonicalizeA</a>(szBuffer, pszPath);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> sValue.assign(szBuffer, bResult ? MAX_PATH : 0);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">return</span> bResult;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>}</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> _Traits, <span class="keyword">class</span> _Ax&gt;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="group___win_std_shell_w_a_p_i.html#ga2bb4436e8e3b7452b48d01cbb18bc818"> 41</a></span><span class="keyword">static</span> BOOL <a class="code hl_function" href="group___win_std_shell_w_a_p_i.html#ga2bb4436e8e3b7452b48d01cbb18bc818">PathCanonicalizeW</a>(_Inout_ std::basic_string&lt;wchar_t, _Traits, _Ax&gt; &amp;sValue, _In_ LPCWSTR pszPath)</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> assert(0); <span class="comment">// TODO: Test this code.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">wchar_t</span> szBuffer[MAX_PATH + 1];</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> BOOL bResult = <a class="code hl_function" href="group___win_std_shell_w_a_p_i.html#ga2bb4436e8e3b7452b48d01cbb18bc818">::PathCanonicalizeW</a>(szBuffer, pszPath);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> sValue.assign(szBuffer, bResult ? MAX_PATH : 0);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">return</span> bResult;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>}</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="ttc" id="a_common_8h_html"><div class="ttname"><a href="_common_8h.html">Common.h</a></div><div class="ttdoc">General API.</div></div>
<div class="ttc" id="agroup___win_std_shell_w_a_p_i_html_ga2bb4436e8e3b7452b48d01cbb18bc818"><div class="ttname"><a href="group___win_std_shell_w_a_p_i.html#ga2bb4436e8e3b7452b48d01cbb18bc818">PathCanonicalizeW</a></div><div class="ttdeci">static BOOL PathCanonicalizeW(std::basic_string&lt; wchar_t, _Traits, _Ax &gt; &amp;sValue, LPCWSTR pszPath)</div><div class="ttdoc">Simplifies a path by removing navigation elements such as &quot;.&quot; and &quot;..&quot; to produce a direct,...</div><div class="ttdef"><b>Definition:</b> Shell.h:41</div></div>
<div class="ttc" id="agroup___win_std_shell_w_a_p_i_html_gabc79615c035f76d08ddced61807b6676"><div class="ttname"><a href="group___win_std_shell_w_a_p_i.html#gabc79615c035f76d08ddced61807b6676">PathCanonicalizeA</a></div><div class="ttdeci">static BOOL PathCanonicalizeA(std::basic_string&lt; char, _Traits, _Ax &gt; &amp;sValue, LPCSTR pszPath)</div><div class="ttdoc">Simplifies a path by removing navigation elements such as &quot;.&quot; and &quot;..&quot; to produce a direct,...</div><div class="ttdef"><b>Definition:</b> Shell.h:24</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2022 15:02:05 for WinStd by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
Generated on Mon Mar 7 2022 09:10:52 for WinStd by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>