AvailableCollectiveBehaviors Property (IPICollective interface)

                    

 

This read-only property returns a NamedValues collection of behaviors that are currently supported by at least one active member of the collective. For example if the user is currently connected to a secondary member server and the primary member is available (not off line) then the collection will indicate that AllowConfigWrites is true.

Syntax

object.AvailableCollectiveBehaviors

The object placeholder is an object expression that evaluates to a IPICollective interface, obtained from a Server object.

Remarks

The values associated with the names in the collection should be treated as booleans and contain 0 for FALSE and a non zero value (typically -1 as with a VARIANT_BOOL) for TRUE. With the initial release of High Availability servers (PI Server 3.4.375) four values are defined in this collection.  More may be added in future versions.  It is possible to alter some of these behaviors with configuration on the server.  The High Availability PI-SDK provides automatic failover when calls are made that require services available on the collective but not available on the current member server.  This collection provides visibility into this process.  If, for example, the Primary member server is down, this collection will reflect the inability of the collective to perform certain functions and if these functions are attempted under those conditions, failover will not occur. 

 

The values currently provided in this table are:

Setting Description
AllowBatchReads If the corresponding value is non-zero, batch data can currently be read on this collective.
AllowBatchWrites If the corresponding value is non-zero, batch data can currently be written on this collective.
AllowSDKWriteValues If the corresponding value is non-zero, the calls to write time history data (UpdateValue, UpdateValues) are currently supported on this collective.
AllowConfigWrites If the corresponding value is non-zero, calls which alter configuration data are currently supported on this collective. This includes managing PIpoints, StateSets, PIUsers, PIGroups, and PointClasses.

 

Trappable Errors

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

Error

Description

E_INVALIDARG, E_POINTER Some of the function argument are not valid.
pseSERVERNOTCOLLECTIVE The Server is not a collective
Enabling Operational Intelligence