MemberAvailability Property (IPICollective interface)

                    

 

This read-only property returns a NamedValues collection of availabilities for all of the collective members. The collection will contain a NamedValue using the name of each collective member.

Syntax

object.MemberAvailability

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. The availability represented by this property may be different than that provided via the named value “IsAvailable” from CollectiveMember.StatusInfo. The StatusInfo is from a given member of the collective and represents the availability as perceived by that server as of the last retrieval. The MemberAvailability property is a representation of the current availability from the viewpoint of the PI-SDK. The PI-SDK determines the availability based on availability broadcasts from member servers as well as recent connection attempts. Also if the user has set the priority of a member to -1 then that member will also appear as not available.

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