AFCase.GetConnections Method (AFBaseElement)
- Last UpdatedSep 18, 2024
- PI System
- AF SDK 2024
- Developer
This method returns a collection of AFConnection objects representing
a connection between the specified element (or child element) and another element
within the case.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156
Syntax
public AFCollectionList<AFConnection> GetConnections( AFBaseElement element )
Public Function GetConnections ( element As AFBaseElement ) As AFCollectionList(Of AFConnection) Dim instance As AFCase Dim element As AFBaseElement Dim returnValue As AFCollectionList(Of AFConnection) returnValue = instance.GetConnections(element)
public: AFCollectionList<AFConnection^>^ GetConnections( AFBaseElement^ element )
member GetConnections : element : AFBaseElement -> AFCollectionList<AFConnection>
Parameters
- element
- Type: OSIsoft.AF.Asset.AFBaseElement
The element associated with the connections being returned. It (or one of its child elements) could be either a source or destination of the connection. Only child elements with a direct ownership through the Parent property will be checked.
Return Value
Type: AFCollectionList<AFConnection>Returns the collection of connections between the elements.
Remarks
This is a subset of the collection returned by the Connections
property plus any connections between a child element and another element within the
case. The specified element must be active for the case.