OPC Studio User's Guide and Reference
Equals(ObjectDescriptor) Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib Namespace > ObjectDescriptor Class > Equals Method : Equals(ObjectDescriptor) Method
The ObjectDescriptor to compare with the current object.

Because the ObjectDescriptor has an implicit conversion from System.Guid and System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a GUID (representing the CLSID of the object) or a string (representing the so-called object descriptor string, such as a ProgID of the server) in place of this parameter, and the corresponding object descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromGuid or FromString static method instead.

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

Determines whether the specified ObjectDescriptor is equal to the current object.
Syntax
'Declaration
 
Protected Overloads Function Equals( _
   ByVal other As ObjectDescriptor _
) As Boolean
'Usage
 
Dim instance As ObjectDescriptor
Dim other As ObjectDescriptor
Dim value As Boolean
 
value = instance.Equals(other)
protected bool Equals( 
   ObjectDescriptor other
)
protected:
bool Equals( 
   ObjectDescriptor^ other
) 

Parameters

other
The ObjectDescriptor to compare with the current object.

Because the ObjectDescriptor has an implicit conversion from System.Guid and System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a GUID (representing the CLSID of the object) or a string (representing the so-called object descriptor string, such as a ProgID of the server) in place of this parameter, and the corresponding object descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromGuid or FromString static method instead.

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

Return Value

true if the specified object is equal to the current object; otherwise, false.
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