'Declaration
<ExtensionAttribute()> <NotNullAttribute()> Public Overloads Shared Function GetFileProperties( _ ByVal fileTransfer As IEasyUAFileTransfer, _ ByVal endpointDescriptor As UAEndpointDescriptor, _ ByVal fileNodeDescriptor As UANodeDescriptor _ ) As UAFileProperties
'Usage
Dim fileTransfer As IEasyUAFileTransfer Dim endpointDescriptor As UAEndpointDescriptor Dim fileNodeDescriptor As UANodeDescriptor Dim value As UAFileProperties value = IEasyUAFileTransferExtension.GetFileProperties(fileTransfer, endpointDescriptor, fileNodeDescriptor)
[Extension()] [NotNull()] public static UAFileProperties GetFileProperties( IEasyUAFileTransfer fileTransfer, UAEndpointDescriptor endpointDescriptor, UANodeDescriptor fileNodeDescriptor )
[Extension()] [NotNull()] public: static UAFileProperties^ GetFileProperties( IEasyUAFileTransfer^ fileTransfer, UAEndpointDescriptor^ endpointDescriptor, UANodeDescriptor^ fileNodeDescriptor )
Parameters
- fileTransfer
- The OPC UA file transfer object that will perform the operation.
This is typically the 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 ToUAEndpointDescriptor or 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). - fileNodeDescriptor
- A node descriptor of the file whose properties should be obtained.
Because the OpcLabs.EasyOpc.UA.UANodeDescriptor has implicit conversions from OpcLabs.EasyOpc.UA.AddressSpace.UANodeId, OpcLabs.EasyOpc.UA.AddressSpace.UANodeElement, OpcLabs.EasyOpc.UA.Navigation.UABrowsePath and System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.AddressSpace.UANodeId object (representing the Id of the OPC UA node), a node element object (from OPC UA browsing), OpcLabs.EasyOpc.UA.Navigation.UABrowsePath object (representing OPC UA absolute browse path), or a string (with expanded node Id text) in place of this parameter, and the corresponding 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.UANodeDescriptor.FromString, OpcLabs.EasyOpc.UA.UANodeDescriptor.FromUABrowsePath, OpcLabs.EasyOpc.UA.UANodeDescriptor.FromUANodeElement or OpcLabs.EasyOpc.UA.UANodeDescriptor.FromUANodeId static method instead.
If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode can be used in the same way to simply pass the server node in place of this parameter, which will use its OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode.EffectiveNodeDescriptor property for the operation.
The value of this parameter cannot be
null
(Nothing
in Visual Basic).
Return Value
This method never returns null
(Nothing
in Visual Basic).