File: c-ch309.htm

package info (click to toggle)
aolserver4 4.5.1-18.1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 12,008 kB
  • sloc: ansic: 45,126; tcl: 5,533; sh: 1,037; makefile: 380; pascal: 219; php: 13
file content (84 lines) | stat: -rw-r--r-- 4,005 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<!--plsfield:text-->
<HTML><HEAD>
<TITLE>C API Reference  -- Ns_ScheduleDaily</TITLE>
<LINK rel=Previous href="c-ch308.htm">
<LINK rel=ToC href="toc.htm">
<LINK rel=Index href="master.htm">
<LINK rel=Next href="c-ch310.htm">
</HEAD><BODY BGCOLOR="#ffffff"><A NAME="topofpage"></A>
<TABLE WIDTH=100%>
  <TR>
    <TD ALIGN=LEFT>
      <A NAME="topofpage"></A> <IMG  SRC="as-c-sm.gif">
    </TD>
    <TD ALIGN=RIGHT>
      <A href="c-ch308.htm"><IMG  BORDER="0" src=navbprev.gif alt="[ Previous ]"></A>
      <A href=toc.htm> <IMG  BORDER="0" src=navbhome.gif alt="[ Contents ]"></A>
      <A href=master.htm> <IMG  BORDER="0" src=navbhelp.gif alt="[ Index ]"></A>
      <A href="c-ch310.htm"> <IMG  BORDER="0" src=navbnext.gif alt="[ Next ]"></A>
      <A name="7983"> </A>
    </TD>
  </TR>
</TABLE>

<a name="289803">
</a><h3>Ns_ScheduleDaily</h3>
<a name="289804">
</a><h4>Overview</h4>
Schedule a procedure to run once a day
<a name="289805">
</a><a name="289806">
</a><h4>Syntax</h4>
<pre>    <a name="289807"></a>int Ns_ScheduleDaily(
    <a name="289808"></a>Ns_SchedProc *proc,
    <a name="289809"></a>void *context,
    <a name="289810"></a>int flags,
    <a name="289811"></a>int hour,
    <a name="289812"></a>int minute,
    <a name="289813"></a>Ns_SchedProc *cleanup
    <a name="289814"></a>);
</pre><p><a name="289815">
</a><h4>Description</h4>
<p><a name="289816">
</a>The Ns_ScheduleDaily function schedules the procedure (<code>proc</code>) to be run once a day at the specified time (<code>hour</code> and <code>minute</code>).</p>
<p><a name="289817">
</a>The <code>proc</code> is the scheduled procedure that will be run once a day. It is a function that takes the context and id of the schedule procedure. The <code>id</code> can be used in the Ns_UnscheduleProc procedure to stop the procedure from being called again.</p>
<pre>    <a name="289818"></a>typedef void (Ns_SchedProc) (void *context, int id);
</pre><p><p><a name="289819">
</a>The <code>context</code> is the context to pass to the scheduled procedure.</p>
<p><a name="289820">
</a>The possible flags are NS_SCHED_ONCE and NS_SCHED_THREAD. If you specify NS_SCHED_ONCE, the procedure will only be executed once on the specified day and time, and it will not be re-scheduled to execute again the next day. By default, the procedure is re-scheduled after every time it is executed.</p>
<p><a name="289821">
</a>If you specify NS_SCHED_THREAD, the procedure will run detached in a separate thread instead of using the one scheduled procedure thread used by all other scheduled procedures. You should use NS_SCHED_THREAD if the procedure will not return immediately. Note that if you use NS_SCHED_THREAD, and the procedure is still active the next time to run occurs, the next run is skipped instead of just delayed.</p>
<p><a name="289822">
</a>The <code>hour</code> can be an integer from 0 to 23, and the <code>minute</code> an integer from 0 to 59.</p>
<p><a name="289823">
</a>The <code>cleanup</code> procedure will be run once when the <code>proc</code> procedure is unscheduled.</p>
<a name="301013">
</a><h4>Examples</h4>
<p><a name="301015">
</a>Run a procedure (MyProc) once in its own thread at 2:30 a.m.:</p>
<pre>    <a name="301017"></a>Ns_ScheduleDaily(myProc, myCtx, NS_SCHED_ONCE | NS_SCHED_THREAD, 
2, 30, NULL)
</pre><p>

<TABLE BORDER="2" CELLPADDING="1" width="100%">
<TR><TD COLSPAN=3><P ALIGN=Center>
<IMG SRC="bluebult.gif">
<A HREF="#topofpage">
<FONT SIZE=-1>Top of Page</FONT></A>
<IMG SRC="bluebult.gif">
</TD></TR>
<TR><TD COLSPAN=3><P ALIGN=Center>
<A href="c-ch308.htm">
<IMG  BORDER="0" src=navbprev.gif alt="[ Previous ]"></A>
<A href=toc.htm>
<IMG  BORDER="0" src=navbhome.gif alt="[ Contents ]"></A>
<A href=master.htm>
<IMG  BORDER="0" src=navbhelp.gif alt="[ Index ]"></A>
<A href="c-ch310.htm">
<IMG  BORDER="0" src=navbnext.gif alt="[ Next ]"></A>
<BR align=center>
<FONT size=-1>Copyright &copy; 1998-99 America Online,
Inc.</FONT>
</TD></TR></TABLE></BODY></HTML><!--plsfield:end-->