Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_searchsort_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: CSearchsortExample 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>CSearchsortExample Class Reference</h1><!-- doxytag: class="CSearchsortExample" -->
<p><a href="class_c_searchsort_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_searchsort_example.html#a236c530105277e1ec161254e8c064c69">~CSearchsortExample</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_searchsort_example.html#ae676fe6d363a9f673c13a86c03bcd69a">CreateClientRegistryL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_searchsort_example.html#a19da4c2573c1558cdc7e4ceeece87619">CreatePopAndSmtpAccountL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_searchsort_example.html#a318c96ba87df0b169eed493743b8efb4">CreateSmtpMessageL</a> (TInt aindex, TDes &aFrominfo, TDes &aToinfo, TDes &aSubjectinfo)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_searchsort_example.html#a47c885dcc5fbbbea3914ea4a957eeed0">SearchSortRequestWithoutIteratorL</a> (TDes &aSender, TBool aCaseSensitivity, TBool aWholeWordSearch, TBool aCombinedSearch, TInt &aResultCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_searchsort_example.html#a1cac2e1191acf6e6de435c0ce7d23931">SearchSortRequestWithIteratorL</a> (TInt &aResultCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_searchsort_example.html#ac01f2c133c9f693889a8f28c6a29352e">SearchSortRequestByQueryIdL</a> (TInt &aResultCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae614395ca07a483d43bd011f4cb36c7d"></a><!-- doxytag: member="CSearchsortExample::HandleSessionEventL" ref="ae614395ca07a483d43bd011f4cb36c7d" args="(TMsvSessionEvent aEvent, TAny *aArg1, TAny *aArg2, TAny *aArg3)" -->
void </td><td class="memItemRight" valign="bottom"><b>HandleSessionEventL</b> (TMsvSessionEvent aEvent, TAny *aArg1, TAny *aArg2, TAny *aArg3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_searchsort_example.html#a627ac5a3ce29ab0581780e2e0eddd0aa">DeleteSmtpMessageL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a245e87e5d2c645e6efd184fd11d95566"></a><!-- doxytag: member="CSearchsortExample::DeleteAccountsL" ref="a245e87e5d2c645e6efd184fd11d95566" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>DeleteAccountsL</b> ()</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_searchsort_example.html">CSearchsortExample</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_searchsort_example.html#aaeca65d7c16e40059e14ac32acc1ebc1">NewL</a> ()</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6336e57350631fdc360f42dd807577e"></a><!-- doxytag: member="CSearchsortExample::iTResultSummary" ref="ac6336e57350631fdc360f42dd807577e" args="" -->
RArray< <a class="el" href="struct_t_result_summary.html">TResultSummary</a> > </td><td class="memItemRight" valign="bottom"><b>iTResultSummary</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_searchsort_example.html">CSearchsortExample</a>. </p>
<p>Definition at line <a class="el" href="searchsortexample_8h_source.html#l00120">120</a> of file <a class="el" href="searchsortexample_8h_source.html">searchsortexample.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a236c530105277e1ec161254e8c064c69"></a><!-- doxytag: member="CSearchsortExample::~CSearchsortExample" ref="a236c530105277e1ec161254e8c064c69" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSearchsortExample::~CSearchsortExample </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="searchsortexample_8cpp_source.html#l00060">60</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aaeca65d7c16e40059e14ac32acc1ebc1"></a><!-- doxytag: member="CSearchsortExample::NewL" ref="aaeca65d7c16e40059e14ac32acc1ebc1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_searchsort_example.html">CSearchsortExample</a> * CSearchsortExample::NewL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ApI Implementation </p>
<p>Definition at line <a class="el" href="searchsortexample_8cpp_source.html#l00038">38</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae676fe6d363a9f673c13a86c03bcd69a"></a><!-- doxytag: member="CSearchsortExample::CreateClientRegistryL" ref="ae676fe6d363a9f673c13a86c03bcd69a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSearchsortExample::CreateClientRegistryL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts a message server session. Creates the client side mtm registry and pop client mtm. KErrNoMemory, KErrNotFound, KErrBadLibraryEntryPoint. </p>
<p>Definition at line <a class="el" href="searchsortexample_8cpp_source.html#l00094">94</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a19da4c2573c1558cdc7e4ceeece87619"></a><!-- doxytag: member="CSearchsortExample::CreatePopAndSmtpAccountL" ref="a19da4c2573c1558cdc7e4ceeece87619" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSearchsortExample::CreatePopAndSmtpAccountL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a pop account and an smtp account. Sets the pop server address to the system address. Sets the login name and password. system wide error codes </p>
<p>Definition at line <a class="el" href="searchsortexample_8cpp_source.html#l00121">121</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a318c96ba87df0b169eed493743b8efb4"></a><!-- doxytag: member="CSearchsortExample::CreateSmtpMessageL" ref="a318c96ba87df0b169eed493743b8efb4" args="(TInt aindex, TDes &aFrominfo, TDes &aToinfo, TDes &aSubjectinfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSearchsortExample::CreateSmtpMessageL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aindex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aFrominfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aToinfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aSubjectinfo</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an smtp message,stores and then commits settings to a specified message store. KErrNoMemory,KErrNotFound,KErrAccessDenied,Standard </p>
<p>Definition at line <a class="el" href="searchsortexample_8cpp_source.html#l00190">190</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a47c885dcc5fbbbea3914ea4a957eeed0"></a><!-- doxytag: member="CSearchsortExample::SearchSortRequestWithoutIteratorL" ref="a47c885dcc5fbbbea3914ea4a957eeed0" args="(TDes &aSender, TBool aCaseSensitivity, TBool aWholeWordSearch, TBool aCombinedSearch, TInt &aResultCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSearchsortExample::SearchSortRequestWithoutIteratorL </td>
<td>(</td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aSearchtext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aCaseSensitivity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aWholeWordSearch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aCombinedSearch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TInt & </td>
<td class="paramname"> <em>aResultCount</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Seachsort request without iterator. </p>
<p>Definition at line <a class="el" href="searchsortexample_8cpp_source.html#l00303">303</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1cac2e1191acf6e6de435c0ce7d23931"></a><!-- doxytag: member="CSearchsortExample::SearchSortRequestWithIteratorL" ref="a1cac2e1191acf6e6de435c0ce7d23931" args="(TInt &aResultCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSearchsortExample::SearchSortRequestWithIteratorL </td>
<td>(</td>
<td class="paramtype">TInt & </td>
<td class="paramname"> <em>aResultCount</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Seachsort request with iterator. </p>
<p>Definition at line <a class="el" href="searchsortexample_8cpp_source.html#l00405">405</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac01f2c133c9f693889a8f28c6a29352e"></a><!-- doxytag: member="CSearchsortExample::SearchSortRequestByQueryIdL" ref="ac01f2c133c9f693889a8f28c6a29352e" args="(TInt &aResultCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSearchsortExample::SearchSortRequestByQueryIdL </td>
<td>(</td>
<td class="paramtype">TInt & </td>
<td class="paramname"> <em>aResultCount</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Seachsort request by QueryId. </p>
<p>Definition at line <a class="el" href="searchsortexample_8cpp_source.html#l00465">465</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a627ac5a3ce29ab0581780e2e0eddd0aa"></a><!-- doxytag: member="CSearchsortExample::DeleteSmtpMessageL" ref="a627ac5a3ce29ab0581780e2e0eddd0aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSearchsortExample::DeleteSmtpMessageL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deleting Smtp message entries </p>
<p>Definition at line <a class="el" href="searchsortexample_8cpp_source.html#l00551">551</a> of file <a class="el" href="searchsortexample_8cpp_source.html">searchsortexample.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>