OPC Studio User's Guide and Reference
GetSourceDescription Method (AbstractBinding)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.LiveBinding Namespace > AbstractBinding Class : GetSourceDescription Method
The format to use, or a null reference.

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

The provider to use to format the value, or a null reference.

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

Obtains the description of the source used with this binding.
Syntax
'Declaration
 
Public Overridable Function GetSourceDescription( _
   ByVal format As String, _
   ByVal formatProvider As IFormatProvider _
) As String
'Usage
 
Dim instance As AbstractBinding
Dim format As String
Dim formatProvider As IFormatProvider
Dim value As String
 
value = instance.GetSourceDescription(format, formatProvider)
public virtual string GetSourceDescription( 
   string format,
   IFormatProvider formatProvider
)
public:
virtual String^ GetSourceDescription( 
   String^ format,
   IFormatProvider^ formatProvider
) 

Parameters

format
The format to use, or a null reference.

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

formatProvider
The provider to use to format the value, or a null reference.

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

Return Value

The source description.

This method never returns null (Nothing in Visual Basic).

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