Add Method (PISubBatches collection)

             

Creates and adds a PISubBatch object to the collection. The PISubBatch is returned.

 

Syntax

object.Add Name, Heading, varStartTime, [varEndTime]

The Add method syntax has these parts:

Part

Description

object

An object expression that evaluates to a PISubBatches collection.

Name

String representing the Name of the PISubBatch; for example, “Heat”.

Heading

PIHeading of the PISubBatch. Must be a defined PIHeading. The definition is used to set the type of sub-batch; such as phase.

varStartTime

 VARIANT representing the start time of the PISubBatch. The VARIANT may be a PITime, DATE, String, or numeric. Interpretation of DATE, strings and numerics is consistent with PITime's interpretation.

varEndTime

Optional VARIANT representing the end time of the PISubBatch. The VARIANT may be a PITime, DATE, String, or numeric. Interpretation of DATE, strings and numerics is consistent with PITime's interpretation. Normally a PISubBatch is created at the start of the sub-batch therefore the end time is not known.

 

Remarks

The Name does not have to be unique within the collection. Each PISubBatch is assigned a UniqueID.

 

This call will fail if the computer doesn't have a network card or if the computer is a laptop running Windows NT4 and is not connected to the network (i.e. the network card has not been initialized).

 

Trappable Errors

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

Error

Description

pseNOGENSERVER

The underlying server abstraction layer could not be accessed.

 

Enabling Operational Intelligence