Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_r_buf_example.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CRBufExample Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CRBufExample Class Reference</h1><!-- doxytag: class="CRBufExample" -->
<p>
<a href="class_c_r_buf_example-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#70b4f8db8bcc7c567f48594d2f7371c5">~CRBufExample</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#57856a0e131215ccef45af713f5aad5f">CreateRBufL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#c33844cce7df0b1c2a57f6edc3ac0906">CreateRBufFromExistingDesL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#398c08c23d056f1705f82ea5117c07e8">CreateRBufFromHBufCL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#7815a44916e13bd2a567a6a25a1ffc6d">CreateRBufFromAllocatedMemoryL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#0a4263b7828a5214748786dae31e66b7">CreateRBufFromAnotherRBufL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#15c0b84f3b6704d60b1e4f3ff50f590b">CreateRBufUsingRReadStreamL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#6de7e813c107211fc904905e39582ee0">SwapTwoRBufsL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#fd4b2bcfb6b0a1fbef134f021ee7bcac">CopyDataUsingAssignmentOperatorL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#da558a684cebf4b9034706007ad7bda0">ReallocateAndFreeTheMemoryBufferL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#9ee071c3749b927f6af99dcb04c6bd4d">ReplaceAndModifyTheDataL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#1d99cb2bef146c76bd1f99908435ecfb">CleanUpRulesL</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_r_buf_example.html">CRBufExample</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#8bd254efe876ae2b5138f79a101272d6">NewL</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class demonstrates:<ul>
<li>creating an empty RBuf,</li><li>creating an RBuf containing a copy of an existing descriptor,</li><li>assigning a descriptor to an RBuf,</li><li>assigning memory to an RBuf,</li><li>reallocating and freeing the memory,</li><li>cleaning up an RBuf,</li><li>replacing and modifying the data held in the RBuf. </li></ul>
<p>Definition at line <a class="el" href="rbufexample_8h-source.html#l00034">34</a> of file <a class="el" href="rbufexample_8h-source.html">rbufexample.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="70b4f8db8bcc7c567f48594d2f7371c5"></a><!-- doxytag: member="CRBufExample::~CRBufExample" ref="70b4f8db8bcc7c567f48594d2f7371c5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CRBufExample::~CRBufExample </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00058">58</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8bd254efe876ae2b5138f79a101272d6"></a><!-- doxytag: member="CRBufExample::NewL" ref="8bd254efe876ae2b5138f79a101272d6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_r_buf_example.html">CRBufExample</a> * CRBufExample::NewL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocates and constructs a <a class="el" href="class_c_r_buf_example.html">CRBufExample</a> object. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_c_r_buf_example.html">CRBufExample</a> object. </dd></dl>
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00067">67</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="57856a0e131215ccef45af713f5aad5f"></a><!-- doxytag: member="CRBufExample::CreateRBufL" ref="57856a0e131215ccef45af713f5aad5f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::CreateRBufL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an empty resizable buffer descriptor using Create() and CreateMax().
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00079">79</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c33844cce7df0b1c2a57f6edc3ac0906"></a><!-- doxytag: member="CRBufExample::CreateRBufFromExistingDesL" ref="c33844cce7df0b1c2a57f6edc3ac0906" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::CreateRBufFromExistingDesL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a resizable buffer descriptor with data copied from another descriptor.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00145">145</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="398c08c23d056f1705f82ea5117c07e8"></a><!-- doxytag: member="CRBufExample::CreateRBufFromHBufCL" ref="398c08c23d056f1705f82ea5117c07e8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::CreateRBufFromHBufCL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a resizable buffer descriptor by assigning data from an HBufC.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00162">162</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="7815a44916e13bd2a567a6a25a1ffc6d"></a><!-- doxytag: member="CRBufExample::CreateRBufFromAllocatedMemoryL" ref="7815a44916e13bd2a567a6a25a1ffc6d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::CreateRBufFromAllocatedMemoryL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a resizable buffer descriptor RBuf from some previously allocated memory.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00267">267</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0a4263b7828a5214748786dae31e66b7"></a><!-- doxytag: member="CRBufExample::CreateRBufFromAnotherRBufL" ref="0a4263b7828a5214748786dae31e66b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::CreateRBufFromAnotherRBufL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a resizable buffer descriptor from another RBuf.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00186">186</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="15c0b84f3b6704d60b1e4f3ff50f590b"></a><!-- doxytag: member="CRBufExample::CreateRBufUsingRReadStreamL" ref="15c0b84f3b6704d60b1e4f3ff50f590b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::CreateRBufUsingRReadStreamL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a resizable buffer descriptor by reading data from an RReadStream.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00211">211</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="6de7e813c107211fc904905e39582ee0"></a><!-- doxytag: member="CRBufExample::SwapTwoRBufsL" ref="6de7e813c107211fc904905e39582ee0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::SwapTwoRBufsL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Swaps the contents of two resizable buffer descriptors.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00291">291</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="fd4b2bcfb6b0a1fbef134f021ee7bcac"></a><!-- doxytag: member="CRBufExample::CopyDataUsingAssignmentOperatorL" ref="fd4b2bcfb6b0a1fbef134f021ee7bcac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::CopyDataUsingAssignmentOperatorL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copies data using the assignment operator from one descriptor to another
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00342">342</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="da558a684cebf4b9034706007ad7bda0"></a><!-- doxytag: member="CRBufExample::ReallocateAndFreeTheMemoryBufferL" ref="da558a684cebf4b9034706007ad7bda0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::ReallocateAndFreeTheMemoryBufferL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reallocates and frees the resizable buffer descriptor.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00381">381</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="9ee071c3749b927f6af99dcb04c6bd4d"></a><!-- doxytag: member="CRBufExample::ReplaceAndModifyTheDataL" ref="9ee071c3749b927f6af99dcb04c6bd4d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::ReplaceAndModifyTheDataL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Replaces and modifies a portion of the data present in an RBuf.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00439">439</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="1d99cb2bef146c76bd1f99908435ecfb"></a><!-- doxytag: member="CRBufExample::CleanUpRulesL" ref="1d99cb2bef146c76bd1f99908435ecfb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRBufExample::CleanUpRulesL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Demonstrates cleanup for resizable buffer descriptors.
<p>Definition at line <a class="el" href="rbufexample_8cpp-source.html#l00490">490</a> of file <a class="el" href="rbufexample_8cpp-source.html">rbufexample.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>