'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function OpenOrCreateStream( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal fileNamedNodeDescriptor As UANamedNodeDescriptor, _
   ByVal fileMode As FileMode, _
   ByVal fileAccess As FileAccess _
) As Stream

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim fileNamedNodeDescriptor As UANamedNodeDescriptor
Dim fileMode As FileMode
Dim fileAccess As FileAccess
Dim value As Stream
 
value = IEasyUAFileTransferExtension2.OpenOrCreateStream(fileTransfer, endpointDescriptor, fileNamedNodeDescriptor, fileMode, fileAccess)

[Extension()]
[NotNull()]
public static Stream OpenOrCreateStream( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor,
   UANamedNodeDescriptor fileNamedNodeDescriptor,
   FileMode fileMode,
   FileAccess fileAccess
)

[Extension()]
[NotNull()]
public:
static Stream^ OpenOrCreateStream( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor,
   UANamedNodeDescriptor^ fileNamedNodeDescriptor,
   FileMode fileMode,
   FileAccess fileAccess
) 

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 stream should be opened or that should be created for the stream.

fileMode

One of the enumeration values that determines how to open or create the file.

fileAccess

A bitwise combination of the enumeration values that sets the System.IO.Stream.CanRead and System.IO.Stream.CanWrite properties of the System.IO.Stream object.

Return Value

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

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.

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