Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > 554fa56029a60daf7aab25253fdab3d8 > files > 150

clanlib0.6-docs-0.6.5-28mdv2008.1.x86_64.rpm


<html>
<head><title>ClanLib Reference: CL_OutputSource_Memory</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_Memory</h1><p>
<b>  Outputsource writing to memory.</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 &lt;ClanLib/core.h&gt;
<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_Memory.html#812"><tt><font color=blue><b>CL_OutputSource_Memory</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_Memory.html#813"><tt><font color=blue><b>~CL_OutputSource_Memory</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_Memory.html#814"><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_Memory.html#815"><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_Memory.html#816"><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_Memory.html#817"><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_Memory.html#818"><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_Memory.html#819"><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_Memory.html#820"><tt><font color=blue><b>clone</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
<p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="812"><font size=+1><b>CL_OutputSource_Memory::CL_OutputSource_Memory</b></font></a> -   Output Source Memory Constructor<br><tt></tt> <a href="CL_OutputSource_Memory.html#812"><tt><font color=blue><b>CL_OutputSource_Memory</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="820"><font size=+1><b>CL_OutputSource_Memory::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_Memory.html#820"><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="819"><font size=+1><b>CL_OutputSource_Memory::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_Memory.html#819"><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="816"><font size=+1><b>CL_OutputSource_Memory::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_Memory.html#816"><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="818"><font size=+1><b>CL_OutputSource_Memory::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_Memory.html#818"><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="815"><font size=+1><b>CL_OutputSource_Memory::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_Memory.html#815"><tt><font color=blue><b>size</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote>  Returns - Size of the output source.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="814"><font size=+1><b>CL_OutputSource_Memory::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_Memory.html#814"><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="817"><font size=+1><b>CL_OutputSource_Memory::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_Memory.html#817"><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 from which to write.<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="813"><font size=+1><b>CL_OutputSource_Memory::~CL_OutputSource_Memory</b></font></a> -   Output Source Memory Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_OutputSource_Memory.html#813"><tt><font color=blue><b>~CL_OutputSource_Memory</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>