This read-only property returns a NamedValues collection of behaviors of the currently connected server. For example if the connection is to a secondary the collection will contain the name “AllowBatchReads” with a value of 0 for false.
The object placeholder is an object expression that evaluates to a IPICollective interface, obtained from a Server object.
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. See the PI server documentation for details.
The values currently provided in this table are:
|AllowBatchReads||If the corresponding value is non-zero, batch data can be read from this member server.|
|AllowBatchWrites||If the corresponding value is non-zero, batch data can be written to this member server.|
|AllowSDKWriteValues||If the corresponding value is non-zero, the calls to write time history data (UpdateValue, UpdateValues) are supported on this member server.|
|AllowConfigWrites||If the corresponding value is non-zero, calls which alter configuration data are supported. This includes managing PIpoints, StateSets, PIUsers, PIGroups, and PointClasses.|
In addition to generic errors (such as Out of Memory), the following errors may occur:
|E_INVALIDARG, E_POINTER||Some of the function argument are not valid.|
|pseSERVERNOTCOLLECTIVE||The Server is not a collective|