CollectiveDescription Property (IPICollective interface)

                    

 

This read-only property returns a string containing the description of the collective to which this server belongs.

 

Syntax

object.CollectiveDescription

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

Remarks

The CollectiveDescription is configured on the server and read and cached by the SDK.

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