Versions Compared

Old Version 6

changes.mady.by.user user-6e56b

Saved on

compared with

New Version Current

changes.mady.by.user Paul Scott

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

Returns a list of the current ShelvedPath objects, which each represent a shelved alarm paths. A "path" may be either a source path, or a display path.. 

Client permissions restrictions


Panel
titleSyntax

system.alarm.getShelvedPaths()

  • Parameters

Nothing

  • Returns

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

  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleExamples
Code Block
languagepy
titleCode Snippet - Getting Paths for All Shelved Alarms
# 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())
Panel
titleKeywords

system alarm getShelvedPaths, alarm.getShelvedPaths