diff options
Diffstat (limited to 'classwinapi_1_1File.html')
| -rw-r--r-- | classwinapi_1_1File.html | 495 |
1 files changed, 495 insertions, 0 deletions
diff --git a/classwinapi_1_1File.html b/classwinapi_1_1File.html new file mode 100644 index 0000000..49e9415 --- /dev/null +++ b/classwinapi_1_1File.html @@ -0,0 +1,495 @@ +<!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"> +<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.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>winapi_common: winapi::File Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.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 style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">winapi_common + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- 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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><b>winapi</b></li><li class="navelem"><a class="el" href="classwinapi_1_1File.html">File</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="classwinapi_1_1File-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">winapi::File Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><a class="el" href="classwinapi_1_1File.html" title="File I/O.">File</a> I/O. + <a href="classwinapi_1_1File.html#details">More...</a></p> +<div class="dynheader"> +Inheritance diagram for winapi::File:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classwinapi_1_1File.png" usemap="#winapi::File_map" alt=""/> + <map id="winapi::File_map" name="winapi::File_map"> +<area href="classwinapi_1_1Handle.html" title="HANDLE wrapper." alt="winapi::Handle" shape="rect" coords="0,0,94,24"/> + </map> +</div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwinapi_1_1File_1_1ID.html">ID</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a4ae67aba44ba64654b888ace9b7dfb36"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#a4ae67aba44ba64654b888ace9b7dfb36">File</a> (<a class="el" href="classwinapi_1_1Handle.html">Handle</a> &&handle)</td></tr> +<tr class="separator:a4ae67aba44ba64654b888ace9b7dfb36"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad3c43351e4c032caa78525fc15e64ca7"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#ad3c43351e4c032caa78525fc15e64ca7">get_size</a> () const</td></tr> +<tr class="separator:ad3c43351e4c032caa78525fc15e64ca7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aed36137d5b730166cfec4e0f8a5a6fdd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structwinapi_1_1File_1_1ID.html">ID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#aed36137d5b730166cfec4e0f8a5a6fdd">query_id</a> () const</td></tr> +<tr class="separator:aed36137d5b730166cfec4e0f8a5a6fdd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classwinapi_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwinapi_1_1Handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classwinapi_1_1Handle.html">winapi::Handle</a></td></tr> +<tr class="memitem:aa005a3f927fab2a3bc5ca930ca22f61f inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="aa005a3f927fab2a3bc5ca930ca22f61f"></a> + </td><td class="memItemRight" valign="bottom"><b>Handle</b> (HANDLE)</td></tr> +<tr class="separator:aa005a3f927fab2a3bc5ca930ca22f61f inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aafd8ce44149f5f2c8e7aeb4d34225ef3 inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="aafd8ce44149f5f2c8e7aeb4d34225ef3"></a> +HANDLE </td><td class="memItemRight" valign="bottom"><b>get</b> () const</td></tr> +<tr class="separator:aafd8ce44149f5f2c8e7aeb4d34225ef3 inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a97d591e2b27613360af81e058a2f527c inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a97d591e2b27613360af81e058a2f527c"></a> +HANDLE </td><td class="memItemRight" valign="bottom"><b>ptr</b> () const</td></tr> +<tr class="separator:a97d591e2b27613360af81e058a2f527c inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2309dd0b3fe0dfe25c5dd1cec30f6e7b inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a2309dd0b3fe0dfe25c5dd1cec30f6e7b"></a> + </td><td class="memItemRight" valign="bottom"><b>operator HANDLE</b> () const</td></tr> +<tr class="separator:a2309dd0b3fe0dfe25c5dd1cec30f6e7b inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0aae8a719302767f7f186f22195a40e6 inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a0aae8a719302767f7f186f22195a40e6"></a> +bool </td><td class="memItemRight" valign="bottom"><b>is_valid</b> () const</td></tr> +<tr class="separator:a0aae8a719302767f7f186f22195a40e6 inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6f28cc73ae2e3e447251cef0160e3555 inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#a6f28cc73ae2e3e447251cef0160e3555">close</a> ()</td></tr> +<tr class="separator:a6f28cc73ae2e3e447251cef0160e3555 inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acc001a0f466d9c92cf7f2ef62896afc5 inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#acc001a0f466d9c92cf7f2ef62896afc5">is_std</a> () const</td></tr> +<tr class="separator:acc001a0f466d9c92cf7f2ef62896afc5 inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae340b095569654f8b709614f23577f2e inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinapi_1_1Buffer.html">Buffer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#ae340b095569654f8b709614f23577f2e">read</a> () const</td></tr> +<tr class="separator:ae340b095569654f8b709614f23577f2e inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a31c8440493e29cdd9b6fc40ffe8c06f1 inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#a31c8440493e29cdd9b6fc40ffe8c06f1">read_chunk</a> (<a class="el" href="classwinapi_1_1Buffer.html">Buffer</a> &read_chunk) const</td></tr> +<tr class="separator:a31c8440493e29cdd9b6fc40ffe8c06f1 inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afbfe1b7de229eb5656504e05acf9bbcc inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#afbfe1b7de229eb5656504e05acf9bbcc">write</a> (const void *data, std::size_t nb) const</td></tr> +<tr class="separator:afbfe1b7de229eb5656504e05acf9bbcc inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aee2ff37831d686a8140403c10d7ebadd inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#aee2ff37831d686a8140403c10d7ebadd">write</a> (const <a class="el" href="classwinapi_1_1Buffer.html">Buffer</a> &buffer) const</td></tr> +<tr class="separator:aee2ff37831d686a8140403c10d7ebadd inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab78fab4796ef5ec3f9576f19b54cfd04 inherit pub_methods_classwinapi_1_1Handle"><td class="memTemplParams" colspan="2">template<typename CharT > </td></tr> +<tr class="memitem:ab78fab4796ef5ec3f9576f19b54cfd04 inherit pub_methods_classwinapi_1_1Handle"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#ab78fab4796ef5ec3f9576f19b54cfd04">write</a> (const std::basic_string< CharT > &src) const</td></tr> +<tr class="separator:ab78fab4796ef5ec3f9576f19b54cfd04 inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a630b9ee6bb6d1669af11005d2fc3c582 inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a630b9ee6bb6d1669af11005d2fc3c582"></a> +void </td><td class="memItemRight" valign="bottom"><b>inherit</b> (bool yes=true) const</td></tr> +<tr class="separator:a630b9ee6bb6d1669af11005d2fc3c582 inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2c4844b0bb53e30ace8ad17f5edde50b inherit pub_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a2c4844b0bb53e30ace8ad17f5edde50b"></a> +void </td><td class="memItemRight" valign="bottom"><b>dont_inherit</b> () const</td></tr> +<tr class="separator:a2c4844b0bb53e30ace8ad17f5edde50b inherit pub_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:ad3bacd22beea28dcb0a0df846b5c4215"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1File.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#ad3bacd22beea28dcb0a0df846b5c4215">open_r</a> (const std::string &)</td></tr> +<tr class="separator:ad3bacd22beea28dcb0a0df846b5c4215"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaa308b06a55f992f71e76f9e7a629647"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1File.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#aaa308b06a55f992f71e76f9e7a629647">open_r</a> (const <a class="el" href="classwinapi_1_1CanonicalPath.html">CanonicalPath</a> &)</td></tr> +<tr class="separator:aaa308b06a55f992f71e76f9e7a629647"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7d7eeb56c9f33f6ec1814472c61e51f4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1File.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#a7d7eeb56c9f33f6ec1814472c61e51f4">open_read_attributes</a> (const std::string &)</td></tr> +<tr class="separator:a7d7eeb56c9f33f6ec1814472c61e51f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aecba0e33d05893021f93a2348aeefa34"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1File.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#aecba0e33d05893021f93a2348aeefa34">open_read_attributes</a> (const <a class="el" href="classwinapi_1_1CanonicalPath.html">CanonicalPath</a> &)</td></tr> +<tr class="separator:aecba0e33d05893021f93a2348aeefa34"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a36cda85b326592d7eadca5dc4a6b7981"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1File.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#a36cda85b326592d7eadca5dc4a6b7981">open_w</a> (const std::string &)</td></tr> +<tr class="separator:a36cda85b326592d7eadca5dc4a6b7981"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a53bc6b8de007c630ac84d6519a520111"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1File.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#a53bc6b8de007c630ac84d6519a520111">open_w</a> (const <a class="el" href="classwinapi_1_1CanonicalPath.html">CanonicalPath</a> &)</td></tr> +<tr class="separator:a53bc6b8de007c630ac84d6519a520111"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a453828fe42006bc7b6e925c41d1e965e"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#a453828fe42006bc7b6e925c41d1e965e">remove</a> (const std::string &)</td></tr> +<tr class="separator:a453828fe42006bc7b6e925c41d1e965e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7aa6987387481fc3b2fc5187b0563e97"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1File.html#a7aa6987387481fc3b2fc5187b0563e97">remove</a> (const <a class="el" href="classwinapi_1_1CanonicalPath.html">CanonicalPath</a> &)</td></tr> +<tr class="separator:a7aa6987387481fc3b2fc5187b0563e97"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_static_methods_classwinapi_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classwinapi_1_1Handle')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classwinapi_1_1Handle.html">winapi::Handle</a></td></tr> +<tr class="memitem:a9c98cce78725c975bfd1f87614c2eaee inherit pub_static_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a9c98cce78725c975bfd1f87614c2eaee"></a> +static bool </td><td class="memItemRight" valign="bottom"><b>is_valid</b> (HANDLE)</td></tr> +<tr class="separator:a9c98cce78725c975bfd1f87614c2eaee inherit pub_static_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1817fdf127291cf5f47d6429d8f468cd inherit pub_static_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1Handle.html">Handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#a1817fdf127291cf5f47d6429d8f468cd">std_in</a> ()</td></tr> +<tr class="separator:a1817fdf127291cf5f47d6429d8f468cd inherit pub_static_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a76e96327afd0b943d996c90289f2883e inherit pub_static_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1Handle.html">Handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#a76e96327afd0b943d996c90289f2883e">std_out</a> ()</td></tr> +<tr class="separator:a76e96327afd0b943d996c90289f2883e inherit pub_static_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a894d880e1241c9516889a7a63a0c1750 inherit pub_static_methods_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1Handle.html">Handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Handle.html#a894d880e1241c9516889a7a63a0c1750">std_err</a> ()</td></tr> +<tr class="separator:a894d880e1241c9516889a7a63a0c1750 inherit pub_static_methods_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pub_static_attribs_classwinapi_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classwinapi_1_1Handle')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="classwinapi_1_1Handle.html">winapi::Handle</a></td></tr> +<tr class="memitem:a6c822b6e0b886e2200e6c7d9dc3e6604 inherit pub_static_attribs_classwinapi_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a6c822b6e0b886e2200e6c7d9dc3e6604"></a> +static constexpr std::size_t </td><td class="memItemRight" valign="bottom"><b>max_chunk_size</b> = 16 * 1024</td></tr> +<tr class="separator:a6c822b6e0b886e2200e6c7d9dc3e6604 inherit pub_static_attribs_classwinapi_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p><a class="el" href="classwinapi_1_1File.html" title="File I/O.">File</a> I/O. </p> +<p>Easily open, read & write files. </p> + +<p class="definition">Definition at line <a class="el" href="file_8hpp_source.html#l00029">29</a> of file <a class="el" href="file_8hpp_source.html">file.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a4ae67aba44ba64654b888ace9b7dfb36"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4ae67aba44ba64654b888ace9b7dfb36">◆ </a></span>File()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">winapi::File::File </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classwinapi_1_1Handle.html">Handle</a> && </td> + <td class="paramname"><em>handle</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Make a <a class="el" href="classwinapi_1_1File.html" title="File I/O.">File</a> instance from an open handle. </p> + +<p class="definition">Definition at line <a class="el" href="file_8hpp_source.html#l00059">59</a> of file <a class="el" href="file_8hpp_source.html">file.hpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="ad3bacd22beea28dcb0a0df846b5c4215"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad3bacd22beea28dcb0a0df846b5c4215">◆ </a></span>open_r() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classwinapi_1_1File.html">File</a> winapi::File::open_r </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>path</em></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>Open file for reading. </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00092">92</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="aaa308b06a55f992f71e76f9e7a629647"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aaa308b06a55f992f71e76f9e7a629647">◆ </a></span>open_r() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classwinapi_1_1File.html">File</a> winapi::File::open_r </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwinapi_1_1CanonicalPath.html">CanonicalPath</a> & </td> + <td class="paramname"><em>path</em></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>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00096">96</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="a7d7eeb56c9f33f6ec1814472c61e51f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7d7eeb56c9f33f6ec1814472c61e51f4">◆ </a></span>open_read_attributes() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classwinapi_1_1File.html">File</a> winapi::File::open_read_attributes </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>path</em></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>Open file for reading (inc. ability to read its attributes). </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00100">100</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="aecba0e33d05893021f93a2348aeefa34"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aecba0e33d05893021f93a2348aeefa34">◆ </a></span>open_read_attributes() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classwinapi_1_1File.html">File</a> winapi::File::open_read_attributes </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwinapi_1_1CanonicalPath.html">CanonicalPath</a> & </td> + <td class="paramname"><em>path</em></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>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00104">104</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="a36cda85b326592d7eadca5dc4a6b7981"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a36cda85b326592d7eadca5dc4a6b7981">◆ </a></span>open_w() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classwinapi_1_1File.html">File</a> winapi::File::open_w </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>path</em></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>Open file for writing. </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00108">108</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="a53bc6b8de007c630ac84d6519a520111"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a53bc6b8de007c630ac84d6519a520111">◆ </a></span>open_w() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classwinapi_1_1File.html">File</a> winapi::File::open_w </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwinapi_1_1CanonicalPath.html">CanonicalPath</a> & </td> + <td class="paramname"><em>path</em></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>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00112">112</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="a453828fe42006bc7b6e925c41d1e965e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a453828fe42006bc7b6e925c41d1e965e">◆ </a></span>remove() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void winapi::File::remove </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>path</em></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>Delete a file. </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00116">116</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="a7aa6987387481fc3b2fc5187b0563e97"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7aa6987387481fc3b2fc5187b0563e97">◆ </a></span>remove() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void winapi::File::remove </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwinapi_1_1CanonicalPath.html">CanonicalPath</a> & </td> + <td class="paramname"><em>path</em></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>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00120">120</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="ad3c43351e4c032caa78525fc15e64ca7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad3c43351e4c032caa78525fc15e64ca7">◆ </a></span>get_size()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::size_t winapi::File::get_size </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get file size. </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="classwinapi_1_1File.html" title="File I/O.">File</a> size, bytes. </dd></dl> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00124">124</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<a id="aed36137d5b730166cfec4e0f8a5a6fdd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aed36137d5b730166cfec4e0f8a5a6fdd">◆ </a></span>query_id()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structwinapi_1_1File_1_1ID.html">File::ID</a> winapi::File::query_id </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get file <a class="el" href="structwinapi_1_1File_1_1ID.html">ID</a>. <a class="el" href="classwinapi_1_1File.html" title="File I/O.">File</a> <a class="el" href="structwinapi_1_1File_1_1ID.html">ID</a> is a unique representation of a file, suitable for hashing. </p> + +<p class="definition">Definition at line <a class="el" href="file_8cpp_source.html#l00139">139</a> of file <a class="el" href="file_8cpp_source.html">file.cpp</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>include/winapi/<a class="el" href="file_8hpp_source.html">file.hpp</a></li> +<li>src/<a class="el" href="file_8cpp_source.html">file.cpp</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 +</small></address> +</body> +</html> |