GetMultipleFileProperties Method (IEasyUAFileTransfer)

Gets properties (metadata) of multiple OPC UA files, specified by their file object nodes.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function GetMultipleFileProperties( _
   ByVal fileNodeArgumentsArray As IReadOnlyList(Of UANodeArguments) _
) As ValueResult(Of UAFileProperties)()

'Usage
 
Dim instance As IEasyUAFileTransfer
Dim fileNodeArgumentsArray As IReadOnlyList(Of UANodeArguments)
Dim value() As ValueResult(Of UAFileProperties)
 
value = instance.GetMultipleFileProperties(fileNodeArgumentsArray)

[NotNull()]
ValueResult<UAFileProperties>[] GetMultipleFileProperties( 
   IReadOnlyList<UANodeArguments> fileNodeArgumentsArray
)

[NotNull()]
array<ValueResult<UAFileProperties^>^>^ GetMultipleFileProperties( 
   IReadOnlyList<UANodeArguments^>^ fileNodeArgumentsArray
)

Parameters

fileNodeArgumentsArray

An array of arguments specifying the server endpoints and node descriptors of the file object nodes.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

Return Value

Returns an array of value result objects. Each element of the array corresponds to the element with the same index in the , and it contains either a UAFileProperties object with the file properties (metadata), or a failure indications (in the OpcLabs.BaseLib.OperationModel.OperationResult.Exception property.)

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

The individual elements of the returned value are never null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	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.

System.ArgumentNullException

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.

Remarks

This method does not throw the OpcLabs.EasyOpc.UA.OperationModel.UAException. Failures related to each operand are indicated in the returned OpcLabs.BaseLib.OperationModel.Generic.ValueResult<T> objects.

Requirements

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

Reference

IEasyUAFileTransfer Interface
IEasyUAFileTransfer Members
GetFileProperties(IEasyUAFileTransfer,UAEndpointDescriptor,UANodeDescriptor) Method
OpcLabs.EasyOpc.UA.FileTransfer.IEasyUAFileTransferExtension.GetMultipleFileProperties(OpcLabs.EasyOpc.UA.FileTransfer.IEasyUAFileTransfer,OpcLabs.EasyOpc.UA.UAEndpointDescriptor,System.Collections.Generic.IReadOnlyList{OpcLabs.EasyOpc.UA.UANodeDescriptor})
UAFileProperties Class

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.