<!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"/>
<title>edelib: TempFile Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">edelib
 <span id="projectnumber">2.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceedelib.html">edelib</a> </li>
<li class="navelem"><a class="el" href="classedelib_1_1TempFile.html">TempFile</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">TempFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="edelib::TempFile" -->
<p>Temporary file class.
<a href="classedelib_1_1TempFile.html#details">More...</a></p>
<p><code>#include <<a class="el" href="TempFile_8h_source.html">edelib/TempFile.h</a>></code></p>
<p><a href="classedelib_1_1TempFile-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#a7888caff7974ef29ad45cf81d93ce9ca">TempFile</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#a6539eb6d4bd819220c79aa5c4e88feba">~TempFile</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#aaef0f35772d459f3552ddd69b8062944">create</a> (const char *prefix, int mode=0600)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#a4e78e3cd062c82439dffc9cddbdd8a20">operator bool</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#ad85687b0f892b9b3bc86a03e5fd7f4b4">unlink</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#addf576577f1694a549052a7a10fc1e9b">close</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#aa13697ccf82798a8d6bf1707ea536ca5">set_auto_delete</a> (bool v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#a53d54d2a438421d36074c36001c9da6b">set_no_close</a> (bool n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#a6550e4ac0110ecda1e5baa06843e51c9">fstream</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#ada0f8ac2b219cc8a90659c3be9e3bf92">name</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#aa548e058fbea5ce62b65dc4d4edc8237">handle</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1TempFile.html#a865f53d4c0e09c18a8702af6c1ea014a">status</a> (void) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Temporary file class. </p>
<p><a class="el" href="classedelib_1_1TempFile.html" title="Temporary file class.">TempFile</a> is responsible for creating unique temporary file.</p>
<p><a class="el" href="classedelib_1_1TempFile.html" title="Temporary file class.">TempFile</a> behaves much as mktemp() or mkstemp() functions: you provide location with <em>templated</em> name, and it will try to create the one, by opening it (like mkstemp()). Templated name ends with XXXXXX. On other hand, if you do not provide XXXXXX-es at the end, <a class="el" href="classedelib_1_1TempFile.html" title="Temporary file class.">TempFile</a> will append them.</p>
<p>This class was greatly inspired by KTempFile from kdelibs because I had no clue how to model it ;) </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7888caff7974ef29ad45cf81d93ce9ca"></a><!-- doxytag: member="edelib::TempFile::TempFile" ref="a7888caff7974ef29ad45cf81d93ce9ca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1TempFile.html">TempFile</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. Does nothing, except setting internal values to invalid state </p>
</div>
</div>
<a class="anchor" id="a6539eb6d4bd819220c79aa5c4e88feba"></a><!-- doxytag: member="edelib::TempFile::~TempFile" ref="a6539eb6d4bd819220c79aa5c4e88feba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classedelib_1_1TempFile.html">TempFile</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. Closes file descriptor too </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="addf576577f1694a549052a7a10fc1e9b"></a><!-- doxytag: member="edelib::TempFile::close" ref="addf576577f1694a549052a7a10fc1e9b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classedelib_1_1TempFile.html#addf576577f1694a549052a7a10fc1e9b">close</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes descriptor </p>
</div>
</div>
<a class="anchor" id="aaef0f35772d459f3552ddd69b8062944"></a><!-- doxytag: member="edelib::TempFile::create" ref="aaef0f35772d459f3552ddd69b8062944" args="(const char *prefix, int mode=0600)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classedelib_1_1TempFile.html#aaef0f35772d459f3552ddd69b8062944">create</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mode</em> = <code>0600</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create file and return creation status. <em>prefix</em> is location where file will be created, with given mode. If file could not be created at all, <a class="el" href="classedelib_1_1TempFile.html#a865f53d4c0e09c18a8702af6c1ea014a">status()</a> will return <em>errno</em> value for further inspection </p>
</div>
</div>
<a class="anchor" id="a6550e4ac0110ecda1e5baa06843e51c9"></a><!-- doxytag: member="edelib::TempFile::fstream" ref="a6550e4ac0110ecda1e5baa06843e51c9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FILE* <a class="el" href="classedelib_1_1TempFile.html#a6550e4ac0110ecda1e5baa06843e51c9">fstream</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return FILE object or NULL if <a class="el" href="classedelib_1_1TempFile.html#aaef0f35772d459f3552ddd69b8062944">create()</a> failed </p>
</div>
</div>
<a class="anchor" id="aa548e058fbea5ce62b65dc4d4edc8237"></a><!-- doxytag: member="edelib::TempFile::handle" ref="aa548e058fbea5ce62b65dc4d4edc8237" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classedelib_1_1TempFile.html#aa548e058fbea5ce62b65dc4d4edc8237">handle</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return file descriptor </p>
</div>
</div>
<a class="anchor" id="ada0f8ac2b219cc8a90659c3be9e3bf92"></a><!-- doxytag: member="edelib::TempFile::name" ref="ada0f8ac2b219cc8a90659c3be9e3bf92" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="classedelib_1_1TempFile.html#ada0f8ac2b219cc8a90659c3be9e3bf92">name</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return temporary file name. If <a class="el" href="classedelib_1_1TempFile.html#aaef0f35772d459f3552ddd69b8062944">create()</a> failed, NULL will be returned </p>
</div>
</div>
<a class="anchor" id="a4e78e3cd062c82439dffc9cddbdd8a20"></a><!-- doxytag: member="edelib::TempFile::operator bool" ref="a4e78e3cd062c82439dffc9cddbdd8a20" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">operator bool </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if <a class="el" href="classedelib_1_1TempFile.html#aaef0f35772d459f3552ddd69b8062944">create()</a> was successfull </p>
</div>
</div>
<a class="anchor" id="aa13697ccf82798a8d6bf1707ea536ca5"></a><!-- doxytag: member="edelib::TempFile::set_auto_delete" ref="aa13697ccf82798a8d6bf1707ea536ca5" args="(bool v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1TempFile.html#aa13697ccf82798a8d6bf1707ea536ca5">set_auto_delete</a> </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If set to true, the file will be deleted when <a class="el" href="classedelib_1_1TempFile.html" title="Temporary file class.">TempFile</a> destructor was called. Default is false </p>
</div>
</div>
<a class="anchor" id="a53d54d2a438421d36074c36001c9da6b"></a><!-- doxytag: member="edelib::TempFile::set_no_close" ref="a53d54d2a438421d36074c36001c9da6b" args="(bool n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1TempFile.html#a53d54d2a438421d36074c36001c9da6b">set_no_close</a> </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If set to true, the file descriptors will not be closed when destructor was called. Default is false </p>
</div>
</div>
<a class="anchor" id="a865f53d4c0e09c18a8702af6c1ea014a"></a><!-- doxytag: member="edelib::TempFile::status" ref="a865f53d4c0e09c18a8702af6c1ea014a" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classedelib_1_1TempFile.html#a865f53d4c0e09c18a8702af6c1ea014a">status</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return errno status </p>
</div>
</div>
<a class="anchor" id="ad85687b0f892b9b3bc86a03e5fd7f4b4"></a><!-- doxytag: member="edelib::TempFile::unlink" ref="ad85687b0f892b9b3bc86a03e5fd7f4b4" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1TempFile.html#ad85687b0f892b9b3bc86a03e5fd7f4b4">unlink</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the file. If file wasn't created successfully before, it will do nothing </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>edelib/<a class="el" href="TempFile_8h_source.html">TempFile.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 5 2012 17:49:03 for edelib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
