Versions Compared

Old Version 4

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 dataset containing information about all stored process programs.

Client permissions restrictions


Panel
titleSyntax

system.secsgem.getToolProgramDataset()

  • Parameters

Nothing

  • Returns

Dataset - A dataset containing information about all stored process programs. Includes the following columns in order: ppid, editDate, bodyFormat.

  • ppid - The name (PPID) of the program.
  • editDate - The last known date the program was saved.
  • bodyFormat - The format of the program. Uses notation matching SECS item definitions: "A" for ASCII, "B" for binary, etc.
  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# Retrieve information about all programs.
results = system.secsgem.getToolProgramDataset()

# Convert the dataset to a PyDataset, since they are easier to iterate over.
pyResults = system.dataset.toPyDataSet(results)
for program in pyResults:
	
	# Print out details on each program.
	print "Program %s was last modified on %s" % (program[0], program[1])
Panel
titleKeywords

system secsgem getToolProgramDataset, secsgem.getToolProgramDataset