<!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"/> <title>ucommon: fbuf Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">ucommon</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('a00048.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> </div> <div class="headertitle"> <h1>fbuf Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="fbuf" --><!-- doxytag: inherits="BufferProtocol,fsys" --> <p>A generic file streaming class built from the buffer protocol. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="a00179_source.html">buffer.h</a>></code></p> <div class="dynheader"> Inheritance diagram for fbuf:</div> <div class="dyncontent"> <div class="center"><img src="a00314.png" border="0" usemap="#fbuf_inherit__map" alt="Inheritance graph"/></div> <map name="fbuf_inherit__map" id="fbuf_inherit__map"> <area shape="rect" id="node2" href="a00026.html" title="Common buffer protocol class." alt="" coords="20,80,183,107"/><area shape="rect" id="node4" href="a00028.html" title="Common character processing protocol." alt="" coords="5,5,197,32"/><area shape="rect" id="node6" href="a00050.html" title="A container for generic and o/s portable threadsafe file system functions." alt="" coords="207,80,268,107"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for fbuf:</div> <div class="dyncontent"> <div class="center"><img src="a00315.png" border="0" usemap="#fbuf_coll__map" alt="Collaboration graph"/></div> <map name="fbuf_coll__map" id="fbuf_coll__map"> <area shape="rect" id="node2" href="a00026.html" title="Common buffer protocol class." alt="" coords="20,80,183,107"/><area shape="rect" id="node4" href="a00028.html" title="Common character processing protocol." alt="" coords="5,5,197,32"/><area shape="rect" id="node6" href="a00050.html" title="A container for generic and o/s portable threadsafe file system functions." alt="" coords="207,80,268,107"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <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"><a class="anchor" id="ad6960026ec86779f584200d23588de09"></a><!-- doxytag: member="fbuf::close" ref="ad6960026ec86779f584200d23588de09" args="(void)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ad6960026ec86779f584200d23588de09">close</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Close the file, flush buffers. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#adfa8e7306ad34a8a66d98623875d1763">create</a> (const char *path, <a class="el" href="a00050.html#a8e5c4bcc76ebe5c9b10f79f1999b0a75">fsys::access_t</a> access=fsys::ACCESS_APPEND, unsigned permissions=0640, size_t size=512)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create and open the specified file. <a href="#adfa8e7306ad34a8a66d98623875d1763"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a789a3f45cf2b43e56a10b6dd1af85708"></a><!-- doxytag: member="fbuf::fbuf" ref="a789a3f45cf2b43e56a10b6dd1af85708" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a789a3f45cf2b43e56a10b6dd1af85708">fbuf</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an unopened file buffer. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a0aeacbd550757babb922b757ed0e696c">fbuf</a> (const char *path, <a class="el" href="a00050.html#a8e5c4bcc76ebe5c9b10f79f1999b0a75">fsys::access_t</a> access, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a file buffer that opens an existing file. <a href="#a0aeacbd550757babb922b757ed0e696c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ac551152591d2ec31d9981618e46f0b12">fbuf</a> (const char *path, <a class="el" href="a00050.html#a8e5c4bcc76ebe5c9b10f79f1999b0a75">fsys::access_t</a> access, unsigned permissions, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a file buffer that creates and opens a specific file. <a href="#ac551152591d2ec31d9981618e46f0b12"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a7f8ef294e37922565d8805f239d673c7">open</a> (const char *path, <a class="el" href="a00050.html#a8e5c4bcc76ebe5c9b10f79f1999b0a75">fsys::access_t</a> access=fsys::ACCESS_RDWR, size_t size=512)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a file buffer that opens an existing file. <a href="#a7f8ef294e37922565d8805f239d673c7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#aca37c1f6e6ac835ee8999525184161e4">seek</a> (<a class="el" href="a00050.html#ae9c080c13d2d885db8f11383c191512d">offset_t</a> offset)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Seek specific offset in open file and reset I/O buffers. <a href="#aca37c1f6e6ac835ee8999525184161e4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00050.html#ae9c080c13d2d885db8f11383c191512d">offset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a679bba092eda500971bad071de5cd118">tell</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Give the current position in the currently open file. <a href="#a679bba092eda500971bad071de5cd118"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a9b9499790440dd0bcf00e1657dde5dda">trunc</a> (<a class="el" href="a00050.html#ae9c080c13d2d885db8f11383c191512d">offset_t</a> offset)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Truncate the currently open file to a specific position. <a href="#a9b9499790440dd0bcf00e1657dde5dda"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ad25a8cca66faa8c1cc921910f5ff22"></a><!-- doxytag: member="fbuf::~fbuf" ref="a3ad25a8cca66faa8c1cc921910f5ff22" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a3ad25a8cca66faa8c1cc921910f5ff22">~fbuf</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy object and release all resources. <br/></td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2b14628f612f5ce95ac1852df081eb7"></a><!-- doxytag: member="fbuf::_clear" ref="af2b14628f612f5ce95ac1852df081eb7" args="(void)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#af2b14628f612f5ce95ac1852df081eb7">_clear</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to clear low level i/o error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a3a42bf2be8e2a425ba249301bd4c2d7c">_err</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to get low level i/o error. <a href="#a3a42bf2be8e2a425ba249301bd4c2d7c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a9af22dbe0b543ec8140632d793e77f5b">_pull</a> (char *address, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to pull buffer from physical i/o (read). <a href="#a9af22dbe0b543ec8140632d793e77f5b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a3cd24d9399a7d3d30ebc7520034fe172">_push</a> (const char *address, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to push buffer into physical i/o (write). <a href="#a3cd24d9399a7d3d30ebc7520034fe172"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e4213fcb5ba79bb02f53678c5ee5364"></a><!-- doxytag: member="fbuf::getfile" ref="a9e4213fcb5ba79bb02f53678c5ee5364" args="(void)" --> fd_t </td><td class="memItemRight" valign="bottom"><b>getfile</b> (void)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A generic file streaming class built from the buffer protocol. </p> <p>This can be used in place of fopen based file operations and does not require libstdc++. </p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl> <p>Definition at line <a class="el" href="a00179_source.html#l00054">54</a> of file <a class="el" href="a00179_source.html">buffer.h</a>.</p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac551152591d2ec31d9981618e46f0b12"></a><!-- doxytag: member="fbuf::fbuf" ref="ac551152591d2ec31d9981618e46f0b12" args="(const char *path, fsys::access_t access, unsigned permissions, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">fbuf::fbuf </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00050.html#a8e5c4bcc76ebe5c9b10f79f1999b0a75">fsys::access_t</a> </td> <td class="paramname"><em>access</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned </td> <td class="paramname"><em>permissions</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a file buffer that creates and opens a specific file. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>of file to create. </td></tr> <tr><td class="paramname">access</td><td>mode of file (rw, rdonly, etc). </td></tr> <tr><td class="paramname">permissions</td><td>of the newly created file. </td></tr> <tr><td class="paramname">size</td><td>of the stream buffer. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a0aeacbd550757babb922b757ed0e696c"></a><!-- doxytag: member="fbuf::fbuf" ref="a0aeacbd550757babb922b757ed0e696c" args="(const char *path, fsys::access_t access, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">fbuf::fbuf </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00050.html#a8e5c4bcc76ebe5c9b10f79f1999b0a75">fsys::access_t</a> </td> <td class="paramname"><em>access</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a file buffer that opens an existing file. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>of existing file to open. </td></tr> <tr><td class="paramname">access</td><td>mode of file (rw, rdonly, etc). </td></tr> <tr><td class="paramname">size</td><td>of the stream buffer. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a3a42bf2be8e2a425ba249301bd4c2d7c"></a><!-- doxytag: member="fbuf::_err" ref="a3a42bf2be8e2a425ba249301bd4c2d7c" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int fbuf::_err </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Method to get low level i/o error. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>error from low level i/o methods. </dd></dl> <p>Implements <a class="el" href="a00026.html#adb9d25e9827e64994be51a3764d220cb">BufferProtocol</a>.</p> </div> </div> <a class="anchor" id="a9af22dbe0b543ec8140632d793e77f5b"></a><!-- doxytag: member="fbuf::_pull" ref="a9af22dbe0b543ec8140632d793e77f5b" args="(char *address, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t fbuf::_pull </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>address</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Method to pull buffer from physical i/o (read). </p> <p>The address is passed to this virtual since it is hidden as private. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">address</td><td>of buffer to pull data into. </td></tr> <tr><td class="paramname">size</td><td>of buffer area being pulled.. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>number of read written, 0 on error or end of data. </dd></dl> <p>Implements <a class="el" href="a00026.html#ad2c4021277a1302c3e622a168da7a040">BufferProtocol</a>.</p> </div> </div> <a class="anchor" id="a3cd24d9399a7d3d30ebc7520034fe172"></a><!-- doxytag: member="fbuf::_push" ref="a3cd24d9399a7d3d30ebc7520034fe172" args="(const char *address, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t fbuf::_push </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>address</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Method to push buffer into physical i/o (write). </p> <p>The address is passed to this virtual since it is hidden as private. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">address</td><td>of data to push. </td></tr> <tr><td class="paramname">size</td><td>of data to push. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes written, 0 on error. </dd></dl> <p>Implements <a class="el" href="a00026.html#a1eab001b291a96fe9ef6e018becad29c">BufferProtocol</a>.</p> </div> </div> <a class="anchor" id="adfa8e7306ad34a8a66d98623875d1763"></a><!-- doxytag: member="fbuf::create" ref="adfa8e7306ad34a8a66d98623875d1763" args="(const char *path, fsys::access_t access=fsys::ACCESS_APPEND, unsigned permissions=0640, size_t size=512)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fbuf::create </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00050.html#a8e5c4bcc76ebe5c9b10f79f1999b0a75">fsys::access_t</a> </td> <td class="paramname"><em>access</em> = <code>fsys::ACCESS_APPEND</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned </td> <td class="paramname"><em>permissions</em> = <code>0640</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> = <code>512</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Create and open the specified file. </p> <p>If a file is currently open, it is closed first. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>of file to create. </td></tr> <tr><td class="paramname">access</td><td>mode of file (rw, rdonly, etc). </td></tr> <tr><td class="paramname">permissions</td><td>of the newly created file. </td></tr> <tr><td class="paramname">size</td><td>of the stream buffer. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a7f8ef294e37922565d8805f239d673c7"></a><!-- doxytag: member="fbuf::open" ref="a7f8ef294e37922565d8805f239d673c7" args="(const char *path, fsys::access_t access=fsys::ACCESS_RDWR, size_t size=512)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fbuf::open </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00050.html#a8e5c4bcc76ebe5c9b10f79f1999b0a75">fsys::access_t</a> </td> <td class="paramname"><em>access</em> = <code>fsys::ACCESS_RDWR</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> = <code>512</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a file buffer that opens an existing file. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>of existing file to open. </td></tr> <tr><td class="paramname">access</td><td>mode of file (rw, rdonly, etc). </td></tr> <tr><td class="paramname">size</td><td>of the stream buffer. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aca37c1f6e6ac835ee8999525184161e4"></a><!-- doxytag: member="fbuf::seek" ref="aca37c1f6e6ac835ee8999525184161e4" args="(offset_t offset)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool fbuf::seek </td> <td>(</td> <td class="paramtype"><a class="el" href="a00050.html#ae9c080c13d2d885db8f11383c191512d">offset_t</a> </td> <td class="paramname"><em>offset</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Seek specific offset in open file and reset I/O buffers. </p> <p>If the file is opened for both read and write, both the read and write position will be reset. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">offset</td><td>to seek. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true if successful. </dd></dl> <p>Reimplemented from <a class="el" href="a00050.html#a9c585b5e3c4266d6b737db61d5093896">fsys</a>.</p> </div> </div> <a class="anchor" id="a679bba092eda500971bad071de5cd118"></a><!-- doxytag: member="fbuf::tell" ref="a679bba092eda500971bad071de5cd118" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00050.html#ae9c080c13d2d885db8f11383c191512d">offset_t</a> fbuf::tell </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Give the current position in the currently open file. </p> <p>If we are appending, this is always seek::end. If we have a file opened for both read and write, this gives the read offset. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>file offset of current i/o operations. </dd></dl> </div> </div> <a class="anchor" id="a9b9499790440dd0bcf00e1657dde5dda"></a><!-- doxytag: member="fbuf::trunc" ref="a9b9499790440dd0bcf00e1657dde5dda" args="(offset_t offset)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool fbuf::trunc </td> <td>(</td> <td class="paramtype"><a class="el" href="a00050.html#ae9c080c13d2d885db8f11383c191512d">offset_t</a> </td> <td class="paramname"><em>offset</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Truncate the currently open file to a specific position. </p> <p>All I/O buffers are reset and the file pointer is set to the end. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">offset</td><td>to truncate. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true if successful. </dd></dl> <p>Reimplemented from <a class="el" href="a00050.html#a11848a8e35eb7fa3f370243595bf4d5b">fsys</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>ucommon/<a class="el" href="a00179_source.html">buffer.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="a00048.html">fbuf</a> </li> <li class="footer">Generated on Wed Apr 13 2011 22:39:47 for ucommon by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </div> </body> </html>