WinStd/group___win_std_shell_w_a_p_i.html

251 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: Shell API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">WinStd
</div>
<div id="projectbrief">Windows Win32 API using Standard C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="doc-content">
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Shell API</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabc79615c035f76d08ddced61807b6676" id="r_gabc79615c035f76d08ddced61807b6676"><td class="memTemplParams" colspan="2">template&lt;class _Traits , class _Ax &gt; </td></tr>
<tr class="memitem:gabc79615c035f76d08ddced61807b6676"><td class="memTemplItemLeft" align="right" valign="top">static BOOL&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#gabc79615c035f76d08ddced61807b6676">PathCanonicalizeA</a> (std::basic_string&lt; char, _Traits, _Ax &gt; &amp;sValue, LPCSTR pszPath)</td></tr>
<tr class="memdesc:gabc79615c035f76d08ddced61807b6676"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simplifies a path by removing navigation elements such as "." and ".." to produce a direct, well-formed path, and stores it in a std::wstring string. <br /></td></tr>
<tr class="separator:gabc79615c035f76d08ddced61807b6676"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bb4436e8e3b7452b48d01cbb18bc818" id="r_ga2bb4436e8e3b7452b48d01cbb18bc818"><td class="memTemplParams" colspan="2">template&lt;class _Traits , class _Ax &gt; </td></tr>
<tr class="memitem:ga2bb4436e8e3b7452b48d01cbb18bc818"><td class="memTemplItemLeft" align="right" valign="top">static BOOL&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ga2bb4436e8e3b7452b48d01cbb18bc818">PathCanonicalizeW</a> (std::basic_string&lt; wchar_t, _Traits, _Ax &gt; &amp;sValue, LPCWSTR pszPath)</td></tr>
<tr class="memdesc:ga2bb4436e8e3b7452b48d01cbb18bc818"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simplifies a path by removing navigation elements such as "." and ".." to produce a direct, well-formed path, and stores it in a std::wstring string. <br /></td></tr>
<tr class="separator:ga2bb4436e8e3b7452b48d01cbb18bc818"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa1ba3f71c61d6d0c7cb611f3cdc193a8" id="r_gaa1ba3f71c61d6d0c7cb611f3cdc193a8"><td class="memTemplParams" colspan="2">template&lt;class _Traits , class _Ax &gt; </td></tr>
<tr class="memitem:gaa1ba3f71c61d6d0c7cb611f3cdc193a8"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#gaa1ba3f71c61d6d0c7cb611f3cdc193a8">PathRemoveBackslashA</a> (std::basic_string&lt; char, _Traits, _Ax &gt; &amp;sValue)</td></tr>
<tr class="memdesc:gaa1ba3f71c61d6d0c7cb611f3cdc193a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the trailing backslash from a given path. <br /></td></tr>
<tr class="separator:gaa1ba3f71c61d6d0c7cb611f3cdc193a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5784e817cc8d4a8e45199e871f61da6c" id="r_ga5784e817cc8d4a8e45199e871f61da6c"><td class="memTemplParams" colspan="2">template&lt;class _Traits , class _Ax &gt; </td></tr>
<tr class="memitem:ga5784e817cc8d4a8e45199e871f61da6c"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ga5784e817cc8d4a8e45199e871f61da6c">PathRemoveBackslashW</a> (std::basic_string&lt; wchar_t, _Traits, _Ax &gt; &amp;sValue)</td></tr>
<tr class="memdesc:ga5784e817cc8d4a8e45199e871f61da6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the trailing backslash from a given path. <br /></td></tr>
<tr class="separator:ga5784e817cc8d4a8e45199e871f61da6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabc79615c035f76d08ddced61807b6676" name="gabc79615c035f76d08ddced61807b6676"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc79615c035f76d08ddced61807b6676">&#9670;&#160;</a></span>PathCanonicalizeA()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class _Traits , class _Ax &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static BOOL PathCanonicalizeA </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; char, _Traits, _Ax &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>sValue</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">LPCSTR</td> <td class="paramname"><span class="paramname"><em>pszPath</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Simplifies a path by removing navigation elements such as "." and ".." to produce a direct, well-formed path, and stores it in a std::wstring string. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/bb773569.aspx">PathCanonicalize function</a> </dd></dl>
</div>
</div>
<a id="ga2bb4436e8e3b7452b48d01cbb18bc818" name="ga2bb4436e8e3b7452b48d01cbb18bc818"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2bb4436e8e3b7452b48d01cbb18bc818">&#9670;&#160;</a></span>PathCanonicalizeW()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class _Traits , class _Ax &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static BOOL PathCanonicalizeW </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; wchar_t, _Traits, _Ax &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>sValue</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">LPCWSTR</td> <td class="paramname"><span class="paramname"><em>pszPath</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Simplifies a path by removing navigation elements such as "." and ".." to produce a direct, well-formed path, and stores it in a std::wstring string. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/bb773569.aspx">PathCanonicalize function</a> </dd></dl>
</div>
</div>
<a id="gaa1ba3f71c61d6d0c7cb611f3cdc193a8" name="gaa1ba3f71c61d6d0c7cb611f3cdc193a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1ba3f71c61d6d0c7cb611f3cdc193a8">&#9670;&#160;</a></span>PathRemoveBackslashA()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class _Traits , class _Ax &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PathRemoveBackslashA </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; char, _Traits, _Ax &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>sValue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the trailing backslash from a given path. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://learn.microsoft.com/en-us/windows/win32/api/shlwapi/nf-shlwapi-pathremovebackslashw">PathRemoveBackslashW function</a> </dd></dl>
</div>
</div>
<a id="ga5784e817cc8d4a8e45199e871f61da6c" name="ga5784e817cc8d4a8e45199e871f61da6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5784e817cc8d4a8e45199e871f61da6c">&#9670;&#160;</a></span>PathRemoveBackslashW()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class _Traits , class _Ax &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PathRemoveBackslashW </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; wchar_t, _Traits, _Ax &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>sValue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the trailing backslash from a given path. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://learn.microsoft.com/en-us/windows/win32/api/shlwapi/nf-shlwapi-pathremovebackslashw">PathRemoveBackslashW function</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Oct 1 2024 14:47:48 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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>