'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.
This is typically the OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClient object.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - endpointDescriptor
- Endpoint descriptor. Identifies the OPC-UA server.
Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has implicit conversions from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromString or OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromUri static method instead.
Also, because the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement and OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement have an implicit conversion to OpcLabs.EasyOpc.UA.UAEndpointDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement (results from OPC UA discovery) in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a (non-null) OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement to OpcLabs.EasyOpc.UA.UAEndpointDescriptor using the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement.ToUAEndpointDescriptor or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement.ToUAEndpointDescriptor method instead.
If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - 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.
Because the OpcLabs.EasyOpc.UA.Navigation.UANamedNodeDescriptor has an implicit conversion from OpcLabs.EasyOpc.UA.UANodeDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.UANodeDescriptor (containing the final node descriptor) in place of this parameter, and the corresponding OPC UA named node descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.Navigation.UANamedNodeDescriptor.FromUANodeDescriptor static method instead.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - append
- Specifies whether to append the text to the file.
- encoding
- The character encoding to use.
The value of this parameter cannot be
null
(Nothing
in Visual Basic).
Return Value
This method never returns null
(Nothing
in Visual Basic).