Add Method (PIHeadings collection)

             

Creates a PIHeading and attaches it to the PIHeadings collection. Returns a reference to the created PIHeading object. 

 

Syntax

object.Add Name, Description, Level

The Add method syntax has these parts:

Part

Description

object

An object expression that evaluates to a PIHeadings collection.

Name

A string containing the new PIHeading Name. Must be unique to the collection.

Description

Description of the new heading.

Level

Long Integer that represents the hierarchical level of the heading. The level must be unique to the collection. Smaller values are considered hierarchically superior.

 

Remarks

PIHeadings are used to define the common naming convention or hierarchy of PIModules and PISubBatch's.

 

Trappable Errors

In addition to generic errors (such as Out of Memory), the following errors may occur:

Error

Description

pseLOADPIHEADINGS

Unable to load the existing collection of PIHeadings from the server.

pseDUPPIHEADING

The named PIHeading already exists on the server.

pseNOGENSERVER

The underlying server abstraction layer could not be accessed.

pseADDPIHEADING

Unable to add the PIHeading to the server. The error description typically contains more information. Most likely because the user didn't have permission to add a PIHeading.

 

Enabling Operational Intelligence