CommonAttribute Method (PointAttributes collection)

                

 

Returns a PointAttribute object from a PointAttributes collection given a constant from the CommonAttributeConstants enumeration.  

 

Syntax

object.CommonAttribute Constant

The CommonAttribute method syntax has these parts:

Part

Description

object

 An object expression that evaluates to a PointAttributes collection.

Constant

A constant from the CommonAttributeConstants enumeration indicating the desired attribute.  See Settings below.

 

Remarks

This method is designed to allow access to standard attributes without knowing the exact name or spelling which would be required using the Item property.  The CommonAttributeConstants enumeration can be accessed through the  PIConstants collection which is obtained from the main PISDK object.  

 

Settings

The possible values for the Constant argument come from the CommonAttributeConstants enumeration as follows.

Value

Description

cmnatrArchiving

Archiving Flag

cmnatrChangeDate

ChangeDate

cmnatrChanger

Last Changer

cmnatrCompDev

Compression Deviation

cmnatrCompDevPercent

Compression Deviation Percent

cmnatrCompMax

Compression Maximum Time

cmnatrCompMin

Compression Minimum Time

cmnatrCompressing

Compressing Flag

cmnatrConvers

Conversion Factor

cmnatrCreationDate

Creation Date

cmnatrCreator

Creator

cmnatrDataAccess

Data Access Permissions

cmnatrDataGroup

Data Group

cmnatrDataOwner

Data Owner

cmnatrDescriptor

Descriptor

cmnatrDigitalSet

Digital Set

cmnatrDisplayDigits

Display Digits

cmnatrEngUnits

Engineering Units

cmnatrExcDev

Exception Deviation

cmnatrExcDevPercent

Exception Deviation Percent

cmnatrExcMax

Exception Maximum

cmnatrExcMin

Exception Minimum

cmnatrExDesc

Extended Descriptor

cmnatrFilterCode

Filter Code

cmnatrInstrumentTag

Instrument Tag

cmnatrLocation1

Location 1

cmnatrLocation2

Location 2

cmnatrLocation3

Location 3

cmnatrLocation4

Location 4

cmnatrLocation5

Location 5

cmnatrPointID

Point Identifier

cmnatrPointSource

Point Source

cmnatrPointType

Point Type

cmnatrPtAccess

Point Access Permissions

cmnatrPtClassID

Point Class Identifier

cmnatrPtClassRev

Point Class Revision

cmnatrPtClassName

Point Class Name

cmnatrPtGroup

Point's Groups

cmnatrPtOwner

Point's Owner

cmnatrRecNo

Record Number

cmnatrScan

Scan Flag

cmnatrShutdown

Shutdown Flag

cmnatrSourceTag

Source Tag

cmnatrSpan

Span

cmnatrSquareRoot

Square Root

cmnatrSrcPtID

Source Point Identifier

cmnatrStep

Step Flag

cmnatrTag

Tag Name

cmnatrTotalCode

Total Code

cmnatrTypicalValue

Typical Value

cmnatrUserInt1

User Integer 1

cmnatrUserInt2

User Integer 2

cmnatrUserReal1

User Real 1

cmnatrUserReal2

User Real 2

cmnatrZero

Zero

 

 

Trappable Errors

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

Error

Description

psePICONSTANTNOTFOUND

The CommonAttributeConstants enumeration was not found in this version of the PI-SDK

pseCONSTENUMNOTFOUND

The passed enumerated constant was not found in the CommonAttributeConstants

psePOINTATTRNOTFOUND

The desired attribute was not found in this PointAttributes collection.

Enabling Operational Intelligence