IsFile Method (EasyUAFileTransferClientCore)

Determines whether the specified node represents an OPC UA file.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function IsFile( _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal nodeDescriptor As UANodeDescriptor _
) As Boolean

'Usage
 
Dim instance As EasyUAFileTransferClientCore
Dim endpointDescriptor As UAEndpointDescriptor
Dim nodeDescriptor As UANodeDescriptor
Dim value As Boolean
 
value = instance.IsFile(endpointDescriptor, nodeDescriptor)

public bool IsFile( 
   UAEndpointDescriptor endpointDescriptor,
   UANodeDescriptor nodeDescriptor
)

public:
bool IsFile( 
   UAEndpointDescriptor^ endpointDescriptor,
   UANodeDescriptor^ nodeDescriptor
)

Parameters

endpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server.
nodeDescriptor: Node descriptor of the node to be tested.

Return Value

Returns true if the node specified by the represents an OPC UA file, i.e. it is an object of type OpcLabs.EasyOpc.UA.AddressSpace.Standard.UAObjectTypeIds.FileType. 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.

Remarks

This method tests for an OPC UA node of object type FileType, which is described here: .

In order to allow for efficient caching, this method is allowed to return a false positive, i.e. you may sometimes receive true when the object does not exist. Attempts to make operations on such object will still fail. The method will always return false when the object does not exist.

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

EasyUAFileTransferClientCore Class
EasyUAFileTransferClientCore Members
FindFile Method
IsFile(IEasyUAFileTransfer,UAEndpointDescriptor,UANamedNodeDescriptor) Method
IsFileOrDirectory(IEasyUAFileTransfer,UAEndpointDescriptor,UANodeDescriptor) Method
IsDirectory Method

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