This function is used in Python Scripting.

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.

Client Permission Restrictions

Permission Type: User Management

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.

Syntax

system.user.removeSchedule(scheduleName)

  • Parameters

String scheduleName - The name of the schedule to delete. Case-sensitive.

  • Returns

UIResponse - A list of UIResponse objects with lists of warnings, errors, and info about the success or failure of the deletion.

  • Scope

Gateway, Vision Client, Perspective Session

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)

"""The example above outputs the following:
Warnings are:
 None
Errors are:
 None
Infos are:
 Schedule "MySchedule" deleted.
"""
Keywords

system user removeSchedule, user.removeSchedule