HasFileSystem(IEasyUAFileTransfer,UAEndpointDescriptor) Method

Determines whether the specified OPC UA object contains a file system object component.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function HasFileSystem( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor _
) As Boolean

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim value As Boolean
 
value = IEasyUAFileTransferExtension.HasFileSystem(fileTransfer, endpointDescriptor)

[Extension()]
public static bool HasFileSystem( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor
)

[Extension()]
public:
static bool HasFileSystem( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor
)

Parameters

fileTransfer: The OPC UA file transfer object that will perform the operation.
endpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server.

Return Value

Returns true is there is a file system object component under the OpcLabs.EasyOpc.UA.AddressSpace.Standard.UAObjectIds.ObjectsFolder. Returns false otherwise.

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
Overload List
OpcLabs.EasyOpc.UA.FileTransfer.IEasyUAFileTransferExtension.FindFileSystem(OpcLabs.EasyOpc.UA.FileTransfer.IEasyUAFileTransfer,OpcLabs.EasyOpc.UA.UAEndpointDescriptor)
GetFileSystem(IEasyUAFileTransfer,UAEndpointDescriptor) Method

Send Documentation 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.