<html> <head><title>ClanLib Reference: CL_OutputSource_File</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_OutputSource_File</h1><p> <b> Outputsource writing to file.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <a href="CL_OutputSource.html">CL_OutputSource</a> <br> Derived by: <i>none</i> <br>Group: Core (I/O Data) <p> #include <ClanLib/core.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_OutputSource_File.html#534"><tt><font color=blue><b>CL_OutputSource_File</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>file</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_OutputSource_File.html#535"><tt><font color=blue><b>CL_OutputSource_File</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_OutputSource_File.html#536"><tt><font color=blue><b>~CL_OutputSource_File</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_OutputSource_File.html#537"><tt><font color=blue><b>tell</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_OutputSource_File.html#538"><tt><font color=blue><b>size</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_OutputSource_File.html#539"><tt><font color=blue><b>get_data</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_OutputSource_File.html#540"><tt><font color=blue><b>write</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=purple>void</font></tt>* <tt><font color=blue>data</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>size</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_OutputSource_File.html#541"><tt><font color=blue><b>open</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_OutputSource_File.html#542"><tt><font color=blue><b>close</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <a href="CL_OutputSource.html"><tt><font color=navy><b>CL_OutputSource</b></font></tt></a>*</tt> </td><td align=right><a href="CL_OutputSource_File.html#543"><tt><font color=blue><b>clone</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="534"><font size=+1><b>CL_OutputSource_File::CL_OutputSource_File</b></font></a> - Output Source File Constructor<br><tt></tt> <a href="CL_OutputSource_File.html#534"><tt><font color=blue><b>CL_OutputSource_File</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>file</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="535"><font size=+1><b>CL_OutputSource_File::CL_OutputSource_File</b></font></a> - Output Source File Constructor<br><tt></tt> <a href="CL_OutputSource_File.html#535"><tt><font color=blue><b>CL_OutputSource_File</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="543"><font size=+1><b>CL_OutputSource_File::clone</b></font></a> - Make a copy of the current outputsource, standing at the same position.<br><tt><tt>virtual</tt> <a href="CL_OutputSource.html"><tt><font color=navy><b>CL_OutputSource</b></font></tt></a>*</tt> <a href="CL_OutputSource_File.html#543"><tt><font color=blue><b>clone</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - The copy of the output source.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="542"><font size=+1><b>CL_OutputSource_File::close</b></font></a> - Closes the output source.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_OutputSource_File.html#542"><tt><font color=blue><b>close</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="539"><font size=+1><b>CL_OutputSource_File::get_data</b></font></a> - Get the pointer to the internal data array in the memory source.<br> Used to extract the data after usage.<br><tt><tt><font color=navy>std::string</font></tt></tt> <a href="CL_OutputSource_File.html#539"><tt><font color=blue><b>get_data</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Pointer to the data written.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="541"><font size=+1><b>CL_OutputSource_File::open</b></font></a> - Opens the output source. By default, it is open.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_OutputSource_File.html#541"><tt><font color=blue><b>open</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="538"><font size=+1><b>CL_OutputSource_File::size</b></font></a> - Returns the size of the output source<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_OutputSource_File.html#538"><tt><font color=blue><b>size</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Current size of output source.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="537"><font size=+1><b>CL_OutputSource_File::tell</b></font></a> - Returns current position in output source.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_OutputSource_File.html#537"><tt><font color=blue><b>tell</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Current position in source.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="540"><font size=+1><b>CL_OutputSource_File::write</b></font></a> - Writes larger amounts of data (no endian and 64 bit conversion):<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_OutputSource_File.html#540"><tt><font color=blue><b>write</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=purple>void</font></tt>* <tt><font color=blue>data</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>size</font></tt>)</tt>;<br><blockquote> data - Points to the array written.<br> size - Number of bytes to write.<br> Returns - Num bytes actually written.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="536"><font size=+1><b>CL_OutputSource_File::~CL_OutputSource_File</b></font></a> - Output Source File Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_OutputSource_File.html#536"><tt><font color=blue><b>~CL_OutputSource_File</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>