Skip to main content
Version: 7.9

system.secsgem.getToolProgramDataset

This function is used in Python Scripting.

Description​

Returns a Dataset containing information about all stored process programs.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.secsgem.getToolProgramDataset()

Parameters​

None

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, Designer, Client

Code Examples​

Code 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])