system.user.removeSchedule

This feature is new in Ignition version 7.8.0

Description

Allows a schedule to be deleted. Note that schedules which are used in Composite Schedules can not be deleted until they are removed from the Composite Schedule.

Syntax

Parameters

String scheduleName - The name of the schedule to delete. Name is case-sensitive.

Returns

UIResponse - an object with lists of warnings, errors, and info about the success or failure of the deletion

Scope

All

Code Examples

Code Snippet

 # This example tries to delete the schedule MySchedule, and prints the results of the action.
 
def printResponse(responseList):
	if len(responseList) > 0:
		for response in responseList:
			print "", response
	else:
		print " None"
 
scheduleName = "MySchedule"
response = system.user.removeSchedule(scheduleName)
 
warnings = response.getWarns()
print "Warnings are:"
printResponse(warnings)
 
errors = response.getErrors()
print "Errors are:"
printResponse(errors)
 
infos = response.getInfos()
print "Infos are:"
printResponse(infos)

Output

Warnings are:
 None
Errors are:
 None
Infos are:
 Schedule "MySchedule" deleted.