mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-20 18:53:47 +00:00
207 lines
11 KiB
HTML
207 lines
11 KiB
HTML
<!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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Crashpad: crashpad::DirectoryReader 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" />
|
|
<link href="crashpad_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">Crashpad
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<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');
|
|
/* @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"><a class="el" href="namespacecrashpad.html">crashpad</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1DirectoryReader.html">DirectoryReader</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classcrashpad_1_1DirectoryReader-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">crashpad::DirectoryReader Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Iterates over the file and directory names in a directory.
|
|
<a href="classcrashpad_1_1DirectoryReader.html#details">More...</a></p>
|
|
|
|
<p><code>#include "util/file/directory_reader.h"</code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aeaebced67a3dec6a513ac23f91e704fd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1DirectoryReader.html#aeaebced67a3dec6a513ac23f91e704fd">Result</a> </td></tr>
|
|
<tr class="memdesc:aeaebced67a3dec6a513ac23f91e704fd"><td class="mdescLeft"> </td><td class="mdescRight">The result of a call to <a class="el" href="classcrashpad_1_1DirectoryReader.html#a34ce59d7d99811e16147edfa0bd12ce4" title="Advances the reader to the next file in the directory. ">NextFile()</a>. <a href="classcrashpad_1_1DirectoryReader.html#aeaebced67a3dec6a513ac23f91e704fd">More...</a><br /></td></tr>
|
|
<tr class="separator:aeaebced67a3dec6a513ac23f91e704fd"><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:a386d05dbcc1927fb4bb37b634de34d9d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1DirectoryReader.html#a386d05dbcc1927fb4bb37b634de34d9d">Open</a> (const base::FilePath &path)</td></tr>
|
|
<tr class="memdesc:a386d05dbcc1927fb4bb37b634de34d9d"><td class="mdescLeft"> </td><td class="mdescRight">Opens the directory specified by <em>path</em> for reading. <a href="#a386d05dbcc1927fb4bb37b634de34d9d">More...</a><br /></td></tr>
|
|
<tr class="separator:a386d05dbcc1927fb4bb37b634de34d9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34ce59d7d99811e16147edfa0bd12ce4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcrashpad_1_1DirectoryReader.html#aeaebced67a3dec6a513ac23f91e704fd">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1DirectoryReader.html#a34ce59d7d99811e16147edfa0bd12ce4">NextFile</a> (base::FilePath *filename)</td></tr>
|
|
<tr class="memdesc:a34ce59d7d99811e16147edfa0bd12ce4"><td class="mdescLeft"> </td><td class="mdescRight">Advances the reader to the next file in the directory. <a href="#a34ce59d7d99811e16147edfa0bd12ce4">More...</a><br /></td></tr>
|
|
<tr class="separator:a34ce59d7d99811e16147edfa0bd12ce4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23ea059efe4057ac3aab0c9560155033"><td class="memItemLeft" align="right" valign="top"><a id="a23ea059efe4057ac3aab0c9560155033"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1DirectoryReader.html#a23ea059efe4057ac3aab0c9560155033">DirectoryFD</a> ()</td></tr>
|
|
<tr class="memdesc:a23ea059efe4057ac3aab0c9560155033"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file descriptor associated with this reader, logging a message and returning -1 on error. <br /></td></tr>
|
|
<tr class="separator:a23ea059efe4057ac3aab0c9560155033"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Iterates over the file and directory names in a directory. </p>
|
|
<p>The names enumerated are relative to the specified directory and do not include ".", "..", or files and directories in subdirectories. </p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="aeaebced67a3dec6a513ac23f91e704fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeaebced67a3dec6a513ac23f91e704fd">◆ </a></span>Result</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classcrashpad_1_1DirectoryReader.html#aeaebced67a3dec6a513ac23f91e704fd">crashpad::DirectoryReader::Result</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The result of a call to <a class="el" href="classcrashpad_1_1DirectoryReader.html#a34ce59d7d99811e16147edfa0bd12ce4" title="Advances the reader to the next file in the directory. ">NextFile()</a>. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aeaebced67a3dec6a513ac23f91e704fdae3587c730cc1aa530fa4ddc9c4204e97"></a>kError </td><td class="fielddoc"><p>An error occurred and a message was logged. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aeaebced67a3dec6a513ac23f91e704fda8c632159fa131f09d04f94e3cbcd8782"></a>kSuccess </td><td class="fielddoc"><p>A file was found. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aeaebced67a3dec6a513ac23f91e704fda6bc7395b22881e13a3b36cd255bce651"></a>kNoMoreFiles </td><td class="fielddoc"><p>No more files were found. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a34ce59d7d99811e16147edfa0bd12ce4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a34ce59d7d99811e16147edfa0bd12ce4">◆ </a></span>NextFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classcrashpad_1_1DirectoryReader.html#aeaebced67a3dec6a513ac23f91e704fd">DirectoryReader::Result</a> crashpad::DirectoryReader::NextFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">base::FilePath * </td>
|
|
<td class="paramname"><em>filename</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Advances the reader to the next file in the directory. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">filename</td><td>The filename of the next file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classcrashpad_1_1DirectoryReader.html#aeaebced67a3dec6a513ac23f91e704fd" title="The result of a call to NextFile(). ">Result</a> value. <em>filename</em> is only valid when <a class="el" href="classcrashpad_1_1DirectoryReader.html#aeaebced67a3dec6a513ac23f91e704fda8c632159fa131f09d04f94e3cbcd8782" title="A file was found. ">Result::kSuccess</a> is returned. If <a class="el" href="classcrashpad_1_1DirectoryReader.html#aeaebced67a3dec6a513ac23f91e704fdae3587c730cc1aa530fa4ddc9c4204e97" title="An error occurred and a message was logged. ">Result::kError</a> is returned, a message will be logged. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a386d05dbcc1927fb4bb37b634de34d9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a386d05dbcc1927fb4bb37b634de34d9d">◆ </a></span>Open()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool crashpad::DirectoryReader::Open </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const base::FilePath & </td>
|
|
<td class="paramname"><em>path</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens the directory specified by <em>path</em> for reading. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path to the directory to read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on failure with a message logged. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>util/file/directory_reader.h</li>
|
|
<li>util/file/directory_reader_posix.cc</li>
|
|
<li>util/file/directory_reader_win.cc</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|