QuickOPC User's Guide and Reference
GetSoundFilePropertyValue(IEasyDAClient,String,String,String) Method



OpcLabs.EasyOpcClassic Assembly > OpcLabs.EasyOpc.DataAccess.Extensions Namespace > IEasyDAClientExtension2 Class > GetSoundFilePropertyValue Method : GetSoundFilePropertyValue(IEasyDAClient,String,String,String) Method
The client object that will perform the operation.
Name of the machine. Determines the computer on which the OPC server is located. May be an empty string, in which case the OPC server is assumed to exist on the local computer or at the computer specified for it by DCOM configuration.
Contains ProgID of the OPC server to read from.
Contains OPC item identifier.
Obtains value of Sound File OPC property for a given OPC item.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function GetSoundFilePropertyValue( _
   ByVal client As IEasyDAClient, _
   ByVal machineName As String, _
   ByVal serverClass As String, _
   ByVal itemId As String _
) As String
'Usage
 
Dim client As IEasyDAClient
Dim machineName As String
Dim serverClass As String
Dim itemId As String
Dim value As String
 
value = IEasyDAClientExtension2.GetSoundFilePropertyValue(client, machineName, serverClass, itemId)
[Extension()]
[NotNull()]
public static string GetSoundFilePropertyValue( 
   IEasyDAClient client,
   string machineName,
   string serverClass,
   string itemId
)
[Extension()]
[NotNull()]
public:
static String^ GetSoundFilePropertyValue( 
   IEasyDAClient^ client,
   String^ machineName,
   String^ serverClass,
   String^ itemId
) 

Parameters

client
The client object that will perform the operation.
machineName
Name of the machine. Determines the computer on which the OPC server is located. May be an empty string, in which case the OPC server is assumed to exist on the local computer or at the computer specified for it by DCOM configuration.
serverClass
Contains ProgID of the OPC server to read from.
itemId
Contains OPC item identifier.

Return Value

Returns a value of this OPC property for a specified OPC item, converted to a proper type.
Exceptions
ExceptionDescription
The OPC "Classic" (or OPC XML-DA) operation has failed.
A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
Requirements

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

See Also

Reference

IEasyDAClientExtension2 Class
IEasyDAClientExtension2 Members
Overload List