Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/taskscheduler_8cpp.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: examples/SysLibs/TaskSchedulerExample/taskscheduler.cpp File 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>examples/SysLibs/TaskSchedulerExample/taskscheduler.cpp File Reference</h1>
<p><a href="taskscheduler_8cpp_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34474868a075bc7571782aac77214fbe"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a34474868a075bc7571782aac77214fbe" args="(KTaskName,"MyTaskName\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTaskName,"MyTaskName\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fe9c80949effc525c0c11557d648518"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a8fe9c80949effc525c0c11557d648518" args="(KTitle,"Task Scheduler example")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTitle,"Task Scheduler example")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1773a2ed28fd093bccb8d69371dfe5da"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a1773a2ed28fd093bccb8d69371dfe5da" args="(KTextPressAKey,"\nPress any key to step through the example\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTextPressAKey,"\nPress any key to step through the example\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0fa1f356ccf64e0a3f03e9a0c202b66"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="af0fa1f356ccf64e0a3f03e9a0c202b66" args="(KExit,"\nPress any key to exit the application")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KExit,"\nPress any key to exit the application")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ed7182a4bef92ceb43558a2c7b2acb6"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a0ed7182a4bef92ceb43558a2c7b2acb6" args="(KPressAKey,"\nPress any key to continue\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KPressAKey,"\nPress any key to continue\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bf2c99864c5655d71a649c4b1ae86aa"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a7bf2c99864c5655d71a649c4b1ae86aa" args="(KConnect,"\nConnecting the client to the task scheduler server")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KConnect,"\nConnecting the client to the task scheduler server")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ba1c9bbe925d8ab3edd334a3352b2d9"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a2ba1c9bbe925d8ab3edd334a3352b2d9" args="(KRegisterClient,"\nRegistering the client\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KRegisterClient,"\nRegistering the client\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa09435ade1ad8c6f036a48a8813e5899"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="aa09435ade1ad8c6f036a48a8813e5899" args="(KCreateSchedule,"Creating a persistent schedule\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KCreateSchedule,"Creating a persistent schedule\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a8c23a59759ce38e151f2034e6c609f"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a1a8c23a59759ce38e151f2034e6c609f" args="(KCreateTask,"Creating task for the schedule\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KCreateTask,"Creating task <a class="el" href="interfacefor.html">for</a> the schedule\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45dfec2fe18f62bc6135c1480948104e"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a45dfec2fe18f62bc6135c1480948104e" args="(KPersistentWait,"Waiting for the persistent task to complete. This will take 20 seconds\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KPersistentWait,"Waiting <a class="el" href="interfacefor.html">for</a> the persistent task to complete. This will take 20 seconds\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a283cc0958845e76d592d0b4f1c49342e"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a283cc0958845e76d592d0b4f1c49342e" args="(KDone,"Task complete \n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KDone,"Task complete \n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b26da0e096e69ed3b64f93771c13886"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a3b26da0e096e69ed3b64f93771c13886" args="(KTransientSchedule,"A transient schedule")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTransientSchedule,"A transient schedule")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe9eedfb628f5d6060d1814ffa953d98"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="afe9eedfb628f5d6060d1814ffa953d98" args="(KTransientWait,"Waiting for the transient task to complete. This will take 20 seconds\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTransientWait,"Waiting <a class="el" href="interfacefor.html">for</a> the transient task to complete. This will take 20 seconds\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e202c8426f294167f18f06a8f586654"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a7e202c8426f294167f18f06a8f586654" args="(KCreateTransient,"\nCreating a transient schedule with non-repeating task\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KCreateTransient,"\nCreating a transient schedule with non-repeating task\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54d91d6bc00b60a2739efce3964e7d9f"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="a54d91d6bc00b60a2739efce3964e7d9f" args="(KDeleteAllTasks,"\nDeleting all the persistent tasks scheduled by this exe")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KDeleteAllTasks,"\nDeleting all the persistent tasks scheduled by this exe")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab255aef0e9da42bf0392703d6959b51f"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="ab255aef0e9da42bf0392703d6959b51f" args="(KDeleteAllSchedules,"\nDeleting all schedules created by this exe\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KDeleteAllSchedules,"\nDeleting all schedules created by this exe\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affece58ddc0f31e34f5295c236e234d1"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="affece58ddc0f31e34f5295c236e234d1" args="(KTask,"Number of task(s) scheduled by us is(are) %d\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTask,"Number of task(s) scheduled by us is(are) %d\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1b411e16d7b3e358c8e9a4f8753d700"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="ac1b411e16d7b3e358c8e9a4f8753d700" args="(KExists,"The tasks scheduled exist\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KExists,"The tasks scheduled exist\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedcf6c930d0cca43c5cff33fdee518ac"></a><!-- doxytag: member="taskscheduler.cpp::_LIT" ref="aedcf6c930d0cca43c5cff33fdee518ac" args="(KOtherTask,"Error! Unexpected schedules not scheduled by this exe exist\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KOtherTask,"Error! Unexpected schedules not scheduled by this exe exist\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="taskscheduler_8cpp.html#a5fb473d4ee18739183215b04dcad6e12">MainL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="taskscheduler_8cpp.html#a8b0fea7c5e4de0484888431020cf3ec9">E32Main</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition in file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a5fb473d4ee18739183215b04dcad6e12"></a><!-- doxytag: member="taskscheduler.cpp::MainL" ref="a5fb473d4ee18739183215b04dcad6e12" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MainL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Much simpler MainL(), uses the new Rendezvous() call to sync with the client</p>
<p>Secure variant Much simpler, uses the new Rendezvous() call to sync with the client </p>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00435">435</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8b0fea7c5e4de0484888431020cf3ec9"></a><!-- doxytag: member="taskscheduler.cpp::E32Main" ref="a8b0fea7c5e4de0484888431020cf3ec9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt E32Main </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns standard error code on exit</p>
<p>Secure variant only Process entry point. Called by client using RProcess API </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Standard Epoc error code on process exit</dd>
<dd>
Standard Epoc error code on process exit Secure variant only Process entry point. Called by client using RProcess API</dd></dl>
<p>Entry point for the example</p>
<p>The below section is added to make the code compatible with v9.1 This is because only exe files are compatible with v9.1</p>
<p>Standard entry point function.</p>
<p>A normal Symbian OS executable provides an E32Main() function which is called by the operating system to start the program. </p>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00458">458</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.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>