Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_task_schedule.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: CTaskSchedule 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>CTaskSchedule Class Reference</h1><!-- doxytag: class="CTaskSchedule" -->
<p><a href="class_c_task_schedule-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_task_schedule.html#a739ccbea3ef8f1dc76440e829f206fb6">~CTaskSchedule</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_schedule.html#ac957da1838fe31cb3f7fe9f6a533f6c5">ConnectAndRegisterL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_schedule.html#a5b7869136d2a8f1c625531ab1c12ef98">PersistentScheduleL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_schedule.html#ac2ed627ab19ecc8d397b63ceacd6aaa4">CreatePersistentScheduleL</a> (TSchedulerItemRef &aRef, const TTsTime &aStartTime)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_schedule.html#aabfef5ace0331f83eb8cd4de511d3d7f">CreateTransientScheduleL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_schedule.html#a3b047bd6e178cbc4964d69adb56e1945">DoesScheduledItemExistL</a> (TSchedulerItemRef &aRef, TBool &aExists)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_schedule.html#a0c3db205409436a0b47b3e11c9d3190f">DeleteSchedulesL</a> (TSchedulerItemRef &aRef, TScheduleFilter aFilter)</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_task_schedule.html">CTaskSchedule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_schedule.html#ad152b61017146041468ce89a4312ddf9">NewLC</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_task_schedule.html">CTaskSchedule</a> is a class that publicly inherits from CBase class</p>
<p>The class demonstrates how to connect and register with the task scheduler server, create persistent and transient schedules and to delete the persistent tasks and schedules. </p>
<p>Definition at line <a class="el" href="taskscheduler_8h_source.html#l00035">35</a> of file <a class="el" href="taskscheduler_8h_source.html">taskscheduler.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a739ccbea3ef8f1dc76440e829f206fb6"></a><!-- doxytag: member="CTaskSchedule::~CTaskSchedule" ref="a739ccbea3ef8f1dc76440e829f206fb6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTaskSchedule::~CTaskSchedule </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="taskscheduler_8cpp_source.html#l00089">89</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad152b61017146041468ce89a4312ddf9"></a><!-- doxytag: member="CTaskSchedule::NewLC" ref="ad152b61017146041468ce89a4312ddf9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_task_schedule.html">CTaskSchedule</a> * CTaskSchedule::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_task_schedule.html">CTaskSchedule</a> object using two phase construction Initialises all member data to their default values. </p>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00064">64</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac957da1838fe31cb3f7fe9f6a533f6c5"></a><!-- doxytag: member="CTaskSchedule::ConnectAndRegisterL" ref="ac957da1838fe31cb3f7fe9f6a533f6c5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskSchedule::ConnectAndRegisterL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects a client to the task scheduler server by creating a session with that server and registers the client with the scheduler. system-wide error codes. </p>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00104">104</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5b7869136d2a8f1c625531ab1c12ef98"></a><!-- doxytag: member="CTaskSchedule::PersistentScheduleL" ref="a5b7869136d2a8f1c625531ab1c12ef98" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskSchedule::PersistentScheduleL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a persistent schedule task by calling <a class="el" href="class_c_task_schedule.html#ac2ed627ab19ecc8d397b63ceacd6aaa4">CreatePersistentScheduleL()</a>. Launches the task executor after adding and scheduling the task. KErrArgument system-wide error codes. </p>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00130">130</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac2ed627ab19ecc8d397b63ceacd6aaa4"></a><!-- doxytag: member="CTaskSchedule::CreatePersistentScheduleL" ref="ac2ed627ab19ecc8d397b63ceacd6aaa4" args="(TSchedulerItemRef &aRef, const TTsTime &aStartTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskSchedule::CreatePersistentScheduleL </td>
<td>(</td>
<td class="paramtype">TSchedulerItemRef & </td>
<td class="paramname"> <em>aRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TTsTime & </td>
<td class="paramname"> <em>aStartTime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a persistent time based schedule with no tasks associated with it but merely contains start and end time information. A persistent schedule is a schedule whose lifetime is not limited to the lifetime of the tasks associated with it. Persistent schedules have their information persisted to disk. On device reboot, this data is read back into memory by the task scheduler server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aRef</em> </td><td>Reference to TSchedulerItemRef for unique identification of the schedule </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aStartTime</em> </td><td>Reference to TTsTime class</td></tr>
</table>
</dd>
</dl>
<p>KErrArgument system-wide error codes. </p>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00197">197</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aabfef5ace0331f83eb8cd4de511d3d7f"></a><!-- doxytag: member="CTaskSchedule::CreateTransientScheduleL" ref="aabfef5ace0331f83eb8cd4de511d3d7f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskSchedule::CreateTransientScheduleL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new, transient, time based schedule, adds a task to it and then edits the schedule and executes the edited schedule. Launches the task executor after scheduling the task. A transient schedule is destroyed when the task is destroyed or power is lost. KErrArgument system-wide error codes. </p>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00240">240</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3b047bd6e178cbc4964d69adb56e1945"></a><!-- doxytag: member="CTaskSchedule::DoesScheduledItemExistL" ref="a3b047bd6e178cbc4964d69adb56e1945" args="(TSchedulerItemRef &aRef, TBool &aExists)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskSchedule::DoesScheduledItemExistL </td>
<td>(</td>
<td class="paramtype">TSchedulerItemRef & </td>
<td class="paramname"> <em>aRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TBool & </td>
<td class="paramname"> <em>aExists</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if a schedule exists </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aRef</em> </td><td>Reference to TSchedulerItemRef for unique identification of the schedule </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aExists</em> </td><td>TBool value, ETrue if the schedule exists, EFalse otherwise system wide error codes </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00353">353</a> of file <a class="el" href="taskscheduler_8cpp_source.html">taskscheduler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0c3db205409436a0b47b3e11c9d3190f"></a><!-- doxytag: member="CTaskSchedule::DeleteSchedulesL" ref="a0c3db205409436a0b47b3e11c9d3190f" args="(TSchedulerItemRef &aRef, TScheduleFilter aFilter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskSchedule::DeleteSchedulesL </td>
<td>(</td>
<td class="paramtype">TSchedulerItemRef & </td>
<td class="paramname"> <em>aRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TScheduleFilter </td>
<td class="paramname"> <em>aFilter</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete all tasks and schedules created by this exe before program exit </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>TSchedulerItemRef</em> </td><td>Reference to TSchedulerItemRef for unique identification of the schedule </td></tr>
<tr><td valign="top"></td><td valign="top"><em>TScheduleFilter</em> </td><td>Reference to a filter when listing the schedules</td></tr>
</table>
</dd>
</dl>
<p>KErrNotFound KErrAbort KErrPermissionDenied, KErrArgument system-wide error codes. </p>
<p>Definition at line <a class="el" href="taskscheduler_8cpp_source.html#l00395">395</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>