Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_cent_rep_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: CCentRepExample 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>CCentRepExample Class Reference</h1><!-- doxytag: class="CCentRepExample" -->
<p><a href="class_c_cent_rep_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_cent_rep_example.html#a971b2383437b99571ed67451d76c9e58">~CCentRepExample</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#a513576b361a857b6cdc737672179a612">ResetL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#a9c9e68c292232731fe5e5608251a05e2">OpenRepositoryL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e29c63f9211c107407e7ab5a667541e"></a><!-- doxytag: member="CCentRepExample::RdChgSetL" ref="a3e29c63f9211c107407e7ab5a667541e" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>RdChgSetL</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#ab96ba0baa8204931f40a32834f1849f3">ReadSettingsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#a4e0ebe8e6bff9c146211cca8748d5739">ChangeSettingsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#a88cdab03335c7b3d261cbf84592b38d4">MoveSettingsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#a5b2b3b4cdba5336eec39b703458c9971">ResetAndNotifyL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#a4d89eb968ca8b89aff9b363e73a4fa38">FindSettingsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#af6321df74160a46e24b176883973d7f5">TransactionFuncL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#af1334cf942baf9af3ac1d53f71af4419">DeleteL</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_cent_rep_example.html">CCentRepExample</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cent_rep_example.html#a6761078f15ec4f9085cb01402f8444a2">NewLC</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_cent_rep_example.html">CCentRepExample</a> demonstrates some uses of the CRepository class. CRepository provides access to the Symbian platform central repository, which is used to store system and application settings.</p>
<p>The class demonstrates how to open a repository, read, write, and delete settings, perform operations in a transaction, find settings, restore default settings, and request change notifications. </p>
<p>Definition at line <a class="el" href="centrepexample_8h_source.html#l00039">39</a> of file <a class="el" href="centrepexample_8h_source.html">centrepexample.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a971b2383437b99571ed67451d76c9e58"></a><!-- doxytag: member="CCentRepExample::~CCentRepExample" ref="a971b2383437b99571ed67451d76c9e58" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCentRepExample::~CCentRepExample </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="centrepexample_8cpp_source.html#l00112">112</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6761078f15ec4f9085cb01402f8444a2"></a><!-- doxytag: member="CCentRepExample::NewLC" ref="a6761078f15ec4f9085cb01402f8444a2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_cent_rep_example.html">CCentRepExample</a> * CCentRepExample::NewLC </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_cent_rep_example.html">CCentRepExample</a> object and leaves it on the cleanup stack. Initialises all member data to their default values. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00086">86</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a513576b361a857b6cdc737672179a612"></a><!-- doxytag: member="CCentRepExample::ResetL" ref="a513576b361a857b6cdc737672179a612" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::ResetL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the whole repository to the state of the initialization file originally used to set it up. KErrNotSupported, system-wide error codes. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00128">128</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9c9e68c292232731fe5e5608251a05e2"></a><!-- doxytag: member="CCentRepExample::OpenRepositoryL" ref="a9c9e68c292232731fe5e5608251a05e2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::OpenRepositoryL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a CRepository object for accessing the repository with the specified UID and displays some of the initial settings. KErrNotFound, KErrAbort, KErrPermissionDenied, KErrArgument, system-wide error codes. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00151">151</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab96ba0baa8204931f40a32834f1849f3"></a><!-- doxytag: member="CCentRepExample::ReadSettingsL" ref="ab96ba0baa8204931f40a32834f1849f3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::ReadSettingsL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads the Changed settings and prints them. KErrNotFound, KErrAbort, KErrPermissionDenied, KErrArgument, system-wide error codes. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00201">201</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4e0ebe8e6bff9c146211cca8748d5739"></a><!-- doxytag: member="CCentRepExample::ChangeSettingsL" ref="a4e0ebe8e6bff9c146211cca8748d5739" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::ChangeSettingsL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets an existing setting to a new value or creates a new setting with a value if the setting doesn't exist. KErrAbort, KErrPermissionDenied, KErrArgument, system-wide error codes. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00181">181</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a88cdab03335c7b3d261cbf84592b38d4"></a><!-- doxytag: member="CCentRepExample::MoveSettingsL" ref="a88cdab03335c7b3d261cbf84592b38d4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::MoveSettingsL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Moves a key from one location to another. KErrAbort, KErrPermissionDenied, KErrArgument, system-wide error codes. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00342">342</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5b2b3b4cdba5336eec39b703458c9971"></a><!-- doxytag: member="CCentRepExample::ResetAndNotifyL" ref="a5b2b3b4cdba5336eec39b703458c9971" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::ResetAndNotifyL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets KInt1 to a different value, resets it and gets notification that this value has changed. KErrAlreadyExists error from IPC or server side resource allocation failure </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00303">303</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4d89eb968ca8b89aff9b363e73a4fa38"></a><!-- doxytag: member="CCentRepExample::FindSettingsL" ref="a4d89eb968ca8b89aff9b363e73a4fa38" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::FindSettingsL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds all the settings for both simple and structured data. Finds all the settings that exist and match the specification given by a partialKey and a mask. Matches occur whenever (key & mask) == (partialKey & mask). KErrAbort, KErrPermissionDenied, KErrArgument, system-wide error codes. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00240">240</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af6321df74160a46e24b176883973d7f5"></a><!-- doxytag: member="CCentRepExample::TransactionFuncL" ref="af6321df74160a46e24b176883973d7f5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::TransactionFuncL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform read and write operations using transactions. KErrLocked, panic. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00358">358</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af1334cf942baf9af3ac1d53f71af4419"></a><!-- doxytag: member="CCentRepExample::DeleteL" ref="af1334cf942baf9af3ac1d53f71af4419" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCentRepExample::DeleteL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deletes 3 settings KInt1_InitialValue, KMoveTarget and KReal1 KErrAbort, KErrPermissionDenied, KErrArgument, system-wide error codes. </p>
<p>Definition at line <a class="el" href="centrepexample_8cpp_source.html#l00431">431</a> of file <a class="el" href="centrepexample_8cpp_source.html">centrepexample.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>