Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_r_buf_example.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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>TB9.2 Example Applications: CRBufExample Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>CRBufExample Class Reference</h1><!-- doxytag: class="CRBufExample" -->
<p><a href="class_c_r_buf_example-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a70b4f8db8bcc7c567f48594d2f7371c5">~CRBufExample</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a57856a0e131215ccef45af713f5aad5f">CreateRBufL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#ac33844cce7df0b1c2a57f6edc3ac0906">CreateRBufFromExistingDesL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a398c08c23d056f1705f82ea5117c07e8">CreateRBufFromHBufCL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a7815a44916e13bd2a567a6a25a1ffc6d">CreateRBufFromAllocatedMemoryL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a0a4263b7828a5214748786dae31e66b7">CreateRBufFromAnotherRBufL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a15c0b84f3b6704d60b1e4f3ff50f590b">CreateRBufUsingRReadStreamL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a6de7e813c107211fc904905e39582ee0">SwapTwoRBufsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#afd4b2bcfb6b0a1fbef134f021ee7bcac">CopyDataUsingAssignmentOperatorL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#ada558a684cebf4b9034706007ad7bda0">ReallocateAndFreeTheMemoryBufferL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a9ee071c3749b927f6af99dcb04c6bd4d">ReplaceAndModifyTheDataL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_r_buf_example.html#a1d99cb2bef146c76bd1f99908435ecfb">CleanUpRulesL</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" 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#a8bd254efe876ae2b5138f79a101272d6">NewL</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class demonstrates:</p>
<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" id="a70b4f8db8bcc7c567f48594d2f7371c5"></a><!-- doxytag: member="CRBufExample::~CRBufExample" ref="a70b4f8db8bcc7c567f48594d2f7371c5" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8bd254efe876ae2b5138f79a101272d6"></a><!-- doxytag: member="CRBufExample::NewL" ref="a8bd254efe876ae2b5138f79a101272d6" 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><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. </p>
<dl class="return"><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>
<a class="anchor" id="a57856a0e131215ccef45af713f5aad5f"></a><!-- doxytag: member="CRBufExample::CreateRBufL" ref="a57856a0e131215ccef45af713f5aad5f" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an empty resizable buffer descriptor using Create() and CreateMax(). </p>
<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>
<a class="anchor" id="ac33844cce7df0b1c2a57f6edc3ac0906"></a><!-- doxytag: member="CRBufExample::CreateRBufFromExistingDesL" ref="ac33844cce7df0b1c2a57f6edc3ac0906" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a resizable buffer descriptor with data copied from another descriptor. </p>
<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>
<a class="anchor" id="a398c08c23d056f1705f82ea5117c07e8"></a><!-- doxytag: member="CRBufExample::CreateRBufFromHBufCL" ref="a398c08c23d056f1705f82ea5117c07e8" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a resizable buffer descriptor by assigning data from an HBufC. </p>
<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>
<a class="anchor" id="a7815a44916e13bd2a567a6a25a1ffc6d"></a><!-- doxytag: member="CRBufExample::CreateRBufFromAllocatedMemoryL" ref="a7815a44916e13bd2a567a6a25a1ffc6d" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a resizable buffer descriptor RBuf from some previously allocated memory. </p>
<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>
<a class="anchor" id="a0a4263b7828a5214748786dae31e66b7"></a><!-- doxytag: member="CRBufExample::CreateRBufFromAnotherRBufL" ref="a0a4263b7828a5214748786dae31e66b7" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a resizable buffer descriptor from another RBuf. </p>
<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>
<a class="anchor" id="a15c0b84f3b6704d60b1e4f3ff50f590b"></a><!-- doxytag: member="CRBufExample::CreateRBufUsingRReadStreamL" ref="a15c0b84f3b6704d60b1e4f3ff50f590b" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a resizable buffer descriptor by reading data from an RReadStream. </p>
<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>
<a class="anchor" id="a6de7e813c107211fc904905e39582ee0"></a><!-- doxytag: member="CRBufExample::SwapTwoRBufsL" ref="a6de7e813c107211fc904905e39582ee0" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Swaps the contents of two resizable buffer descriptors. </p>
<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>
<a class="anchor" id="afd4b2bcfb6b0a1fbef134f021ee7bcac"></a><!-- doxytag: member="CRBufExample::CopyDataUsingAssignmentOperatorL" ref="afd4b2bcfb6b0a1fbef134f021ee7bcac" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copies data using the assignment operator from one descriptor to another </p>
<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>
<a class="anchor" id="ada558a684cebf4b9034706007ad7bda0"></a><!-- doxytag: member="CRBufExample::ReallocateAndFreeTheMemoryBufferL" ref="ada558a684cebf4b9034706007ad7bda0" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reallocates and frees the resizable buffer descriptor. </p>
<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>
<a class="anchor" id="a9ee071c3749b927f6af99dcb04c6bd4d"></a><!-- doxytag: member="CRBufExample::ReplaceAndModifyTheDataL" ref="a9ee071c3749b927f6af99dcb04c6bd4d" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replaces and modifies a portion of the data present in an RBuf. </p>
<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>
<a class="anchor" id="a1d99cb2bef146c76bd1f99908435ecfb"></a><!-- doxytag: member="CRBufExample::CleanUpRulesL" ref="a1d99cb2bef146c76bd1f99908435ecfb" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Demonstrates cleanup for resizable buffer descriptors. </p>
<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>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>