'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function OpenOrCreateStreamWriter( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal fileNamedNodeDescriptor As UANamedNodeDescriptor, _
   ByVal append As Boolean, _
   ByVal encoding As Encoding _
) As StreamWriter

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim fileNamedNodeDescriptor As UANamedNodeDescriptor
Dim append As Boolean
Dim encoding As Encoding
Dim value As StreamWriter
 
value = IEasyUAFileTransferExtension2.OpenOrCreateStreamWriter(fileTransfer, endpointDescriptor, fileNamedNodeDescriptor, append, encoding)

[Extension()]
[NotNull()]
public static StreamWriter OpenOrCreateStreamWriter( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor,
   UANamedNodeDescriptor fileNamedNodeDescriptor,
   bool append,
   Encoding encoding
)

[Extension()]
[NotNull()]
public:
static StreamWriter^ OpenOrCreateStreamWriter( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor,
   UANamedNodeDescriptor^ fileNamedNodeDescriptor,
   bool append,
   Encoding^ encoding
) 

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 on which the text file writer should be opened or that should be created for the text file writer.

append

Specifies whether to append the text to the file.

encoding

The character encoding to use.

Return Value

If the OPC UA file does not already exist, the method creates it.

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.

For this method to succeed if it is creating a new file, the fileNamedNodeDescriptor must contain both the named node path (of the parent directory) in the OpcLabs.EasyOpc.UA.Navigation.UANamedNodeDescriptor.NamedNodePath property, and the node name (name of the file) in the OpcLabs.EasyOpc.UA.Navigation.UANamedNodeDescriptor.NodeName property. If this method is opening an existing stream, the file can also be specified using just the final node descriptor (node of the file object) in the OpcLabs.EasyOpc.UA.Navigation.UANamedNodeDescriptor.FinalNodeDescriptor property.

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 writable file provider (using GetWritableFileProvider), and make use of its methods, and methods available on the writable directory contents (obtained using OpcLabs.BaseLib.Extensions.FileProviders.IWritableDirectory.GetWritableDirectoryContents) or writable file info (obtained using OpcLabs.BaseLib.Extensions.FileProviders.IWritableDirectory.GetWritableFileInfo).

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