File: Poco.TemporaryFile.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (73 lines) | stat: -rw-r--r-- 7,936 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<!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>
<title>Class Poco::TemporaryFile</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class TemporaryFile</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Filesystem<br />
<b>Header:</b> Poco/TemporaryFile.h</p>
<h2>Description</h2>
<div class="description">
<p>The <a href="Poco.TemporaryFile.html" title="class Poco::TemporaryFile">TemporaryFile</a> class helps with the handling of temporary files. A unique name for the temporary file is automatically chosen and the file is placed in the directory reserved for temporary files (see <a href="Poco.Path.html#9278" title="Poco::Path::temp()">Path::temp</a>()). Obtain the path by calling the path() method (inherited from <a href="Poco.File.html" title="class Poco::File">File</a>). </p>
<p>The <a href="Poco.TemporaryFile.html" title="class Poco::TemporaryFile">TemporaryFile</a> class does not actually create the file - this is up to the application. The class does, however, delete the temporary file - either in the destructor, or immediately before the application terminates. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.File.html" title="class Poco::File">File</a></p>
<p><b>All Base Classes: </b>FileImpl, <a href="Poco.File.html" title="class Poco::File">File</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.TemporaryFile.html#10703" title="Poco::TemporaryFile::keep()">keep</a>, <a href="Poco.TemporaryFile.html#10704" title="Poco::TemporaryFile::keepUntilExit()">keepUntilExit</a>, <a href="Poco.TemporaryFile.html#10705" title="Poco::TemporaryFile::registerForDeletion()">registerForDeletion</a>, <a href="Poco.TemporaryFile.html#10707" title="Poco::TemporaryFile::tempName()">tempName</a></p>
<p><b>Inherited Functions: </b><a href="Poco.File.html#6930" title="Poco::File::canExecute()">canExecute</a>, <a href="Poco.File.html#6928" title="Poco::File::canRead()">canRead</a>, <a href="Poco.File.html#6929" title="Poco::File::canWrite()">canWrite</a>, <a href="Poco.File.html#6978" title="Poco::File::copyDirectory()">copyDirectory</a>, <a href="Poco.File.html#6949" title="Poco::File::copyTo()">copyTo</a>, <a href="Poco.File.html#6959" title="Poco::File::createDirectories()">createDirectories</a>, <a href="Poco.File.html#6958" title="Poco::File::createDirectory()">createDirectory</a>, <a href="Poco.File.html#6957" title="Poco::File::createFile()">createFile</a>, <a href="Poco.File.html#6936" title="Poco::File::created()">created</a>, <a href="Poco.File.html#6927" title="Poco::File::exists()">exists</a>, <a href="Poco.File.html#6937" title="Poco::File::getLastModified()">getLastModified</a>, <a href="Poco.File.html#6940" title="Poco::File::getSize()">getSize</a>, <a href="Poco.File.html#6976" title="Poco::File::handleLastError()">handleLastError</a>, <a href="Poco.File.html#6934" title="Poco::File::isDevice()">isDevice</a>, <a href="Poco.File.html#6933" title="Poco::File::isDirectory()">isDirectory</a>, <a href="Poco.File.html#6931" title="Poco::File::isFile()">isFile</a>, <a href="Poco.File.html#6935" title="Poco::File::isHidden()">isHidden</a>, <a href="Poco.File.html#6932" title="Poco::File::isLink()">isLink</a>, <a href="Poco.File.html#6960" title="Poco::File::list()">list</a>, <a href="Poco.File.html#6951" title="Poco::File::moveTo()">moveTo</a>, <a href="Poco.File.html#6966" title="Poco::File::operator !=()">operator&nbsp;!=</a>, <a href="Poco.File.html#6968" title="Poco::File::operator <()">operator&nbsp;&lt;</a>, <a href="Poco.File.html#6970" title="Poco::File::operator <=()">operator&nbsp;&lt;=</a>, <a href="Poco.File.html#6916" title="Poco::File::operator =()">operator&nbsp;=</a>, <a href="Poco.File.html#6964" title="Poco::File::operator ==()">operator&nbsp;==</a>, <a href="Poco.File.html#6972" title="Poco::File::operator >()">operator&nbsp;&gt;</a>, <a href="Poco.File.html#6974" title="Poco::File::operator >=()">operator&nbsp;&gt;=</a>, <a href="Poco.File.html#6926" title="Poco::File::path()">path</a>, <a href="Poco.File.html#6955" title="Poco::File::remove()">remove</a>, <a href="Poco.File.html#6953" title="Poco::File::renameTo()">renameTo</a>, <a href="Poco.File.html#6947" title="Poco::File::setExecutable()">setExecutable</a>, <a href="Poco.File.html#6938" title="Poco::File::setLastModified()">setLastModified</a>, <a href="Poco.File.html#6945" title="Poco::File::setReadOnly()">setReadOnly</a>, <a href="Poco.File.html#6941" title="Poco::File::setSize()">setSize</a>, <a href="Poco.File.html#6943" title="Poco::File::setWriteable()">setWriteable</a>, <a href="Poco.File.html#6924" title="Poco::File::swap()">swap</a></p>
<h2>Constructors</h2>
<h3><a name="10701">TemporaryFile</a></h3>
<p class="decl"><a href="Poco.TemporaryFile.html" title="class Poco::TemporaryFile">TemporaryFile</a>();</p>
<div class="description">
<p>Creates the <a href="Poco.TemporaryFile.html" title="class Poco::TemporaryFile">TemporaryFile</a>. </p>
</div>
<h2>Destructor</h2>
<h3><a name="10702">~TemporaryFile</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.TemporaryFile.html" title="class Poco::TemporaryFile">TemporaryFile</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.TemporaryFile.html" title="class Poco::TemporaryFile">TemporaryFile</a> and deletes the corresponding file on disk unless <a href="Poco.TemporaryFile.html#10703" title="Poco::TemporaryFile::keep()">keep</a>() or <a href="Poco.TemporaryFile.html#10704" title="Poco::TemporaryFile::keepUntilExit()">keepUntilExit</a>() has been called. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="10703">keep</a></h3>
<p class="decl">void keep();</p>
<div class="description">
<p>Disables automatic deletion of the file in  the destructor. </p>
</div>
<h3><a name="10704">keepUntilExit</a></h3>
<p class="decl">void keepUntilExit();</p>
<div class="description">
<p>Disables automatic deletion of the file in the destructor, but registers the file for deletion at process termination. </p>
</div>
<h3><a name="10705">registerForDeletion</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void registerForDeletion(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; path<br />);</p>
<div class="description">
<p>Registers the given file for deletion at process termination. </p>
</div>
<h3><a name="10707">tempName</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static std::string tempName();</p>
<div class="description">
<p>Returns a unique path name for a temporary file in the system's scratch directory (see <a href="Poco.Path.html#9278" title="Poco::Path::temp()">Path::temp</a>()). </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>