DeleteSystemPauseTimes function
Syntax
DeleteSystemPauseTimes(StartDay, StartTime, EndDay, EndTime)Description
Use the DeleteSystemPauseTimes function to delete pause times that occur on your system by adding a row to the system pause times table.
A pause time is an interval of time during which the node becomes inactive. When the pause time begins, the node is shut down until the pause time is scheduled to end.
Parameters
| Parameter | Description |
|---|---|
|
StartDay |
Specify a number from 0-6. The values are: |
| Value | Description |
|---|---|
|
0 |
Sunday |
|
1 |
Monday |
|
2 |
Tuesday |
|
3 |
Wednesday |
|
4 |
Thursday |
|
5 |
Friday |
|
6 |
Saturday |
| Parameter | Description |
|---|---|
|
StartTime |
Specify a time, in seconds, since midnight. |
|
EndDay |
Specify a number from 0-6. The values are: |
| Value | Description |
|---|---|
|
0 |
Sunday |
|
1 |
Monday |
|
2 |
Tuesday |
|
3 |
Wednesday |
|
4 |
Thursday |
|
5 |
Friday |
|
6 |
Saturday |
| Parameter | Description |
|---|---|
|
EndTime |
Specify a time, in seconds, since midnight. |
Returns
A Boolean value: True if the system pause time specified was deleted, False otherwise.
Example
Component Boolean &spt_changed;
/* deleting a system pause time interval; */
If Not DeleteSystemPauseTimes(PSSPTIMES.STARTINGDAY, PSSPTIMES.STARTINGSECOND,⇒
PSSPTIMES.ENDINGDAY, PSSPTIMES.ENDINGSECOND) Then
Error MsgGetText(117, 15, "");
Else
&spt_changed = True;
/* to force a save; */
PSSPTIMES.MSGSPTNAME = " ";
DoSave();
End-If;