'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ReadAllText( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal fileNamedNodeDescriptor As UANamedNodeDescriptor _
) As String

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim fileNamedNodeDescriptor As UANamedNodeDescriptor
Dim value As String
 
value = IEasyUAFileTransferExtension2.ReadAllText(fileTransfer, endpointDescriptor, fileNamedNodeDescriptor)

[Extension()]
[NotNull()]
public static string ReadAllText( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor,
   UANamedNodeDescriptor fileNamedNodeDescriptor
)

[Extension()]
[NotNull()]
public:
static String^ ReadAllText( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor,
   UANamedNodeDescriptor^ fileNamedNodeDescriptor
) 

Parameters

fileTransfer

The OPC UA file transfer object that will perform the operation.

endpointDescriptor

Endpoint descriptor. Identifies the OPC-UA server.

fileNamedNodeDescriptor

The named node descriptor of the file whose contents should be read.

Return Value

This method is similar to FileSystem.ReadAllText Method for normal (operating system) files.

CAUTION: This method does not throw the usual OpcLabs.EasyOpc.UA.OperationModel.UAException. Instead, an System.IO.IOException is thrown in case of an error during the operation.

Note: This method allows you to read from a text file. The contents of the file are returned as a string.

The file encoding can be specified if the contents of the file are in an encoding such as ASCII or UTF-8. If you are reading from a file with extended characters, you need to specify the file encoding using the appropriate overload of this method.

See OPC UA File Transfer internals for information about Stream buffering.

Recommendation: Whenever possible, do not use this method directly, and use a higher-level abstraction instead. You can obtain a file provider (using GetFileProvider2), and make use of its methods, and methods available on the directory contents (obtained using Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)) or file info (obtained using Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)).

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