OPC Studio User's Guide and Reference
BelongsTo Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.LiveMapping.Extensions Namespace > AbstractMappingExtension Class : BelongsTo Method
The mapping.

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

The target object to be tested.

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

false if the target object must belong directly to this mapping; true if the target object can also belong to the parent, recursively.
Determines whether a given target object belongs to this mapping.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Function BelongsTo( _
   ByVal abstractMapping As AbstractMapping, _
   ByVal targetObject As Object, _
   ByVal recurse As Boolean _
) As Boolean
'Usage
 
Dim abstractMapping As AbstractMapping
Dim targetObject As Object
Dim recurse As Boolean
Dim value As Boolean
 
value = AbstractMappingExtension.BelongsTo(abstractMapping, targetObject, recurse)

Parameters

abstractMapping
The mapping.

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

targetObject
The target object to be tested.

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

recurse
false if the target object must belong directly to this mapping; true if the target object can also belong to the parent, recursively.

Return Value

true if the target object belongs to this mapping; false otherwise.
Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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