Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/taskexecutor_8cpp.html
Week 28 contribution of SDK documentation content. See release notes for details. Fixes bugs Bug 1897 and Bug 1522.
<!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/taskexecutor.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/taskexecutor.cpp File Reference</h1>
<p><a href="taskexecutor_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="a910d7d0dff62a9971ba4857d5fb3d647"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a910d7d0dff62a9971ba4857d5fb3d647" args="(KTaskConsoleName,"TaskExecutor")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTaskConsoleName,"TaskExecutor")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad663f1d9e723f36232abefcd0a0109ac"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="ad663f1d9e723f36232abefcd0a0109ac" args="(KContent,"\nContents of task file:\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KContent,"\nContents of task file:\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b1849e2227351b8b76bf9ccbc7620de"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a2b1849e2227351b8b76bf9ccbc7620de" args="(KTask,"\nRunning task: %S")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTask,"\nRunning task: %S")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b6813aed3abafc9d536606b871fe5f9"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a7b6813aed3abafc9d536606b871fe5f9" args="(KTaskData,"\nThis is the task data for a")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTaskData,"\nThis is the task data <a class="el" href="interfacefor.html">for</a> a")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a071a2e1a14ff179ded8da5e01caab668"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a071a2e1a14ff179ded8da5e01caab668" args="(KTaskId,"\nThe task Id is: %d\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTaskId,"\nThe task Id is: %d\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bd14fe71918f0bfbd56230ea6e87598"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a7bd14fe71918f0bfbd56230ea6e87598" args="(KValidity,"Task is valid until %S\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KValidity,"Task is valid until %S\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d745ed73604b8bb797c083159e05019"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a8d745ed73604b8bb797c083159e05019" args="(KDateString,"%H%:1%T %*E%*D%X%*N%Y %1 %2 %3")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KDateString,"%H%:1%T %*E%*D%X%*N%Y %1 %2 %3")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7347a4a1b321c5e174f321538e34ce31"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a7347a4a1b321c5e174f321538e34ce31" args="(KPressAnyKey,"Press any key to continue \n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KPressAnyKey,"Press any key to continue \n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f552c1e7525fd4a28403e3d27dda6ac"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a6f552c1e7525fd4a28403e3d27dda6ac" args="(KAbort,"\nCapabilities of the task scheduler and the executor do not match. Task aborted\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KAbort,"\nCapabilities of the task scheduler and the executor do not match. Task aborted\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a105550cdb15f13ab5004d17c31e8179d"></a><!-- doxytag: member="taskexecutor.cpp::_LIT" ref="a105550cdb15f13ab5004d17c31e8179d" args="(KSidMismatch,"SID of the task executor is not same as that of the scheduler. Task aborted\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KSidMismatch,"SID of the task executor is not same as that of the scheduler. Task aborted\n")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="taskexecutor_8cpp.html#ad51792a4c3cfb76bbbd1f61050928332">TaskExecuteL</a> (RFile &aTaskFile)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d8d735ffff0047d4b49f80731f10a34"></a><!-- doxytag: member="taskexecutor.cpp::Execute" ref="a8d8d735ffff0047d4b49f80731f10a34" args="()" -->
TInt </td><td class="memItemRight" valign="bottom"><b>Execute</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GLDEF_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="taskexecutor_8cpp.html#a0f358e9c4355138f629b8c4f37310295">E32Main</a> ()</td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e3e010e023b0fc2c3cc546eb1fb0bee"></a><!-- doxytag: member="taskexecutor.cpp::KTaskSchedulerSid" ref="a2e3e010e023b0fc2c3cc546eb1fb0bee" args="" -->
const TUint32 </td><td class="memItemRight" valign="bottom"><b>KTaskSchedulerSid</b> = 0xE80000B5</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13329867681b6c957835919b2205d7ae"></a><!-- doxytag: member="taskexecutor.cpp::KTaskCapability" ref="a13329867681b6c957835919b2205d7ae" args="" -->
const TCapability </td><td class="memItemRight" valign="bottom"><b>KTaskCapability</b> = ECapabilityWriteDeviceData</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition in file <a class="el" href="taskexecutor_8cpp_source.html">taskexecutor.cpp</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ad51792a4c3cfb76bbbd1f61050928332"></a><!-- doxytag: member="taskexecutor.cpp::TaskExecuteL" ref="ad51792a4c3cfb76bbbd1f61050928332" args="(RFile &aTaskFile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TaskExecuteL </td>
<td>(</td>
<td class="paramtype">RFile & </td>
<td class="paramname"> <em>aTaskFile</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts task data, and puts up a message on the console. Validates the security of the task requester by a) Checking the secure ID; and b) Capabilities of the task requester. </p>
<p>Definition at line <a class="el" href="taskexecutor_8cpp_source.html#l00049">49</a> of file <a class="el" href="taskexecutor_8cpp_source.html">taskexecutor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0f358e9c4355138f629b8c4f37310295"></a><!-- doxytag: member="taskexecutor.cpp::E32Main" ref="a0f358e9c4355138f629b8c4f37310295" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLDEF_C 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="taskexecutor_8cpp_source.html#l00147">147</a> of file <a class="el" href="taskexecutor_8cpp_source.html">taskexecutor.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>