Skip to main content
Version: 8.1

system.alarm.getShelvedPaths

This function is used in Python Scripting.

Description

Returns a list of ShelvedPath objects, which each represent a shelved alarm.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.alarm.getShelvedPaths()

Parameters

Nothing

Returns

List[ShelvedPath] - A list of ShelvedPath objects. See Scripting Object Reference.

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Example #1
# The following code prints a list of the shelved alarms paths and prints them to the console.
paths = system.alarm.getShelvedPaths()
for p in paths:
print "Path: %s, Shelved by: %s, expires: %s, is expired? %s" % (p.getPath(), p.getUser(), p.getExpiration(), p.isExpired())