GetFileName Method

Obtains a name of a given OPC UA file object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function GetFileName( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal fileNodeDescriptor As UANodeDescriptor _
) As String

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim fileNodeDescriptor As UANodeDescriptor
Dim value As String
 
value = IEasyUAFileTransferExtension.GetFileName(fileTransfer, endpointDescriptor, fileNodeDescriptor)

[Extension()]
[NotNull()]
public static string GetFileName( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor,
   UANodeDescriptor fileNodeDescriptor
)

[Extension()]
[NotNull()]
public:
static String^ GetFileName( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor,
   UANodeDescriptor^ fileNodeDescriptor
)

Parameters

fileTransfer: The OPC UA file transfer object that will perform the operation.
endpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server.
fileNodeDescriptor: A node descriptor of the file whose name should be obtained.

Return Value

Returns a name of the file specified by .

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.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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

IEasyUAFileTransferExtension Class
IEasyUAFileTransferExtension Members
GetDirectoryName Method
OpcLabs.EasyOpc.UA.FileTransfer.IEasyUAFileTransferExtension.GetMultipleNames(OpcLabs.EasyOpc.UA.FileTransfer.IEasyUAFileTransfer,OpcLabs.EasyOpc.UA.UAEndpointDescriptor,System.Collections.Generic.IReadOnlyList{OpcLabs.EasyOpc.UA.UANodeDescriptor})

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