OPC Studio User's Guide and Reference
GetIsIncluded Method



OpcLabs.BaseLibComponents Assembly > OpcLabs.BaseLib.Connectivity Namespace > CompositeConnectivity Class : GetIsIncluded Method
The connectivity on which the extender property resides.

The value of this parameter cannot be null (Nothing in Visual Basic).

Determines whether a connectivity is included in this composite.
Syntax
'Declaration
 
Public Function GetIsIncluded( _
   ByVal connectivity As IConnectivity _
) As Boolean
'Usage
 
Dim instance As CompositeConnectivity
Dim connectivity As IConnectivity
Dim value As Boolean
 
value = instance.GetIsIncluded(connectivity)
public bool GetIsIncluded( 
   IConnectivity connectivity
)
public:
bool GetIsIncluded( 
   IConnectivity^ connectivity
) 

Parameters

connectivity
The connectivity on which the extender property resides.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

true if the connectivity is included in the composite; false otherwise.
Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also