OPC Studio User's Guide and Reference
EasyUAFileTransferClient Class Methods


OpcLabs.EasyOpcUAComponents Assembly > OpcLabs.EasyOpc.UA.FileTransfer Namespace : EasyUAFileTransferClient Class

For a list of all members of this type, see EasyUAFileTransferClient members.

Public Methods
 NameDescription
Public MethodAsClientAllows treating the specialized client as normal OPC UA client object. (Inherited from OpcLabs.EasyOpc.UA.EasyUASpecializedClient)
Public MethodCloneOverridden.   
Public MethodCloseFileCloses an OPC UA file. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodCreateDirectoryCreates a new OPC UA directory, organized under an existing one. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodCreateFileCreates a new OPC UA file, organized under an existing directory, and optionally opens it. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDeleteDeletes an OPC UA file or directory, organized under an existing directory. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodDisposeOverloaded.  (Inherited from System.ComponentModel.Component)
Public MethodEquals (Inherited from object)
Public MethodFindDirectoryFinds a directory object with the given name under the specified parent directory. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodFindFileFinds a file object with the given name under the specified parent directory. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodFindFileSystemFinds a file system object component under the specified OPC UA object. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodFindParentDirectoryFind a parent directory of a file or another directory. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodGetFilePositionProvides the current position of the file handle. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodGetHashCodeServes as the default hash function. (Inherited from object)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetMultipleFilePropertiesGets properties (metadata) of multiple OPC UA files, specified by their file object nodes. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodGetMultipleNamesGets names of multiple OPC UA files or directories, specified by their object nodes. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodGetObjectData (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodGetSchema (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodGetService (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodGetTypeGets the System.Type of the current instance. (Inherited from object)
Public MethodHasTraitInfrastructure. (Inherited from OpcLabs.EasyOpc.UA.EasyUASpecializedClient)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIsDirectoryDetermines whether the specified node represents an OPC UA directory. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodIsFileDetermines whether the specified node represents an OPC UA file. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodListDirectoryNamesObtains names of directories under the specified parent OPC UA directory. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodListFileNamesObtains names of files under the specified parent OPC UA directory. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodMoveOrCopyMoves or copies an OPC UA file or directory to another directory, or renames a file or directory. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodOpenFileOpens an OPC UA file (represented by a file object in the OPC UA address space). (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodReadFileReads a part of the file, starting from the current file position. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodReadXml (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodSetFilePositionSets the current position of the file handle. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodToString (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodValueEqualsOverloaded. Defines a generalized method that classes must implement to create type-specific method for determining value equality of instances. Determines whether this instance has the same value as a given other instance. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodWriteFileWrite a part of the file, starting from the current file position. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Public MethodWriteXml (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Protected Methods
 NameDescription
Protected MethodConstructInfrastructure. (Inherited from OpcLabs.EasyOpc.UA.FileTransfer.EasyUAFileTransferClientCore)
Protected MethodFinalize (Inherited from System.ComponentModel.Component)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnContextTypesChangedInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodReadXmlElementInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodWriteXmlElementInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Extension Methods
 NameDescription
Public Extension MethodBrowseDirectoriesOverloaded. Browses for directories under the specified OPC UA directory.
Public Extension MethodBrowseFilesOverloaded. Browses for files under the specified OPC UA directory.
Public Extension MethodBrowseTreeOverloaded. Browses a tree of objects available in the OPC UA directory.
Public Extension MethodCopyOverloaded. Copies an OPC UA file or directory to another directory.
Public Extension MethodCopyFileOverloaded. Copies an OPC UA file to another directory.
Public Extension MethodCreateAndOpenFileCreates a new OPC UA file, organized under an existing directory, and immediately opens it.
Public Extension MethodCreateDirectoryOverloaded. Creates a new directory under an existing OPC UA directory.
Public Extension MethodCreateFileCreates a new file under an existing OPC UA directory.
Public Extension MethodCreateOrOpenFileOpens an existing OPC UA file, or creates a new OPC UA file if it does not exist yet.
Public Extension MethodCreateStreamOverloaded. Creates a new OPC UA file and provides a System.IO.Stream to access it for reading/writing.
Public Extension MethodDeleteOverloaded. Deletes an existing OPC UA file or directory.
Public Extension MethodDeleteDirectoryOverloaded. Deletes an existing OPC UA directory.
Public Extension MethodDeleteDirectoryIfExistsDeletes an OPC UA directory if it exists (does nothing if the directory does not exist).
Public Extension MethodDeleteFileOverloaded. Deletes an existing OPC UA file.
Public Extension MethodDeleteFileIfExistsOverloaded. Deletes an OPC UA file if it exists (does nothing if the file does not exist).

If the file does not exist, the method does nothing (it does not throw an exception).

Public Extension MethodDeleteIfExistsOverloaded. Deletes an OPC UA file or directory if it exists (does nothing if the file or directory does not exist).

If the file or directory does not exist, the method does nothing (it does not throw an exception).

Public Extension MethodEnumerateDirectoriesOverloaded. Enumerates directories under the specified OPC UA directory.
Public Extension MethodEnumerateFilesOverloaded. Enumerates files under the specified OPC UA directory.
Public Extension MethodFindDirectoryOverloaded. Finds a directory object under the specified parent directory.
Public Extension MethodFindFileOverloaded. Finds a file object under the specified parent directory.
Public Extension MethodFindFileOrDirectoryOverloaded. Finds a file or directory object under the specified parent directory.
Public Extension MethodFindFileSystemFinds a file system object component under the specified OPC UA object.
Public Extension MethodFindOrCreateAllDirectoriesOverloaded. Finds or creates an OPC UA directory with given path and name.

The method finds an OPC UA directory with given path and name; it creates the directory, together with the directories on the path, if they are not found.

Public Extension MethodFindOrCreateDirectoryFinds an OPC UA directory with given name; creates the directory if not found.
Public Extension MethodFindRootAndPathFinds a root directory of the specified OPC UA file or directory object, and a named node path from the root directory to the specified object.
Public Extension MethodFindRootDirectoryFinds a root directory of the specified OPC UA file or directory object.
Public Extension MethodGetDirectoryOverloaded. Obtains a node descriptor of an OPC UA directory object.
Public Extension MethodGetDirectoryContents2Overloaded. Gets a directory contents object for the specified OPC UA directory.
Public Extension MethodGetDirectoryNameObtains a name of a given OPC UA directory object.
Public Extension MethodGetFileOverloaded. Obtains a node descriptor of an OPC UA file object.
Public Extension MethodGetFileInfo2Overloaded. Gets a file info object for the specified OPC UA file.
Public Extension MethodGetFileNameObtains a name of a given OPC UA file object.
Public Extension MethodGetFileOrDirectoryOverloaded. Obtains a node descriptor of an OPC UA file or directory object.
Public Extension MethodGetFilePropertiesOverloaded. Obtain properties (file metadata) of a specified OPC UA file.
Public Extension MethodGetFileProvider2Gets a file provider on the specified OPC UA directory.
Public Extension MethodGetFileSystemOverloaded. Obtains a file system object component under the specified OPC UA object.
Public Extension MethodGetMultipleFilePropertiesObtain properties (file metadata) of multiple specified OPC UA files.
Public Extension MethodGetMultipleNamesObtains names of given OPC UA file or directory objects.
Public Extension MethodGetNameObtains a names of a given OPC UA file or directory object.
Public Extension MethodGetParentDirectoryObtains node descriptor of a parent directory of a specified OPC UA file or directory.
Public Extension MethodGetRootDirectoryObtains node descriptor of a root directory of a specified OPC UA file or directory.
Public Extension MethodGetWritableDirectoryContentsOverloaded. Gets a writable directory contents object for the specified OPC UA directory.
Public Extension MethodGetWritableFileInfoOverloaded. Gets a writable file info object for the specified OPC UA file.
Public Extension MethodGetWritableFileProviderGets a writable file provider on the specified OPC UA directory.
Public Extension MethodHasFileSystemOverloaded. Determines whether the specified OPC UA object contains a file system object component.
Public Extension MethodHasParentDirectoryDetermines whether the specified OPC UA file or directory has a parent directory object.
Public Extension MethodIsDirectoryOverloaded. Determines whether the specified OPC UA node is an OPC UA directory object.
Public Extension MethodIsFileOverloaded. Determines whether the specified OPC UA node is an OPC UA file object.
Public Extension MethodIsFileOrDirectoryOverloaded. Determines whether the specified OPC UA node is an OPC UA file or directory object.
Public Extension MethodIsRootDirectoryDetermines whether the specified OPC UA directory is a root directory.
Public Extension MethodListDirectoryNamesOverloaded. Obtains names of directories under the specified OPC UA directory.
Public Extension MethodListFileAndDirectoryNamesOverloaded. Obtains names of files and directories under the specified OPC UA directory.
Public Extension MethodListFileNamesOverloaded. Obtains names of files under the specified OPC UA directory.
Public Extension MethodMoveOverloaded. Moves an OPC UA file or directory to another directory, or renames a file or directory.

The method moves an OPC UA file or directory to another directory, if a different directory has been specified. Otherwise, it renames a file or directory, keeping it in the original directory.

Public Extension MethodMoveDirectoryOverloaded. Moves an OPC UA directory to another directory, or renames a directory.

The method moves an OPC UA directory to another directory, if a different directory has been specified. Otherwise, it renames a directory, keeping it in the original directory.

Public Extension MethodMoveFileOverloaded. Moves an OPC UA file to another directory, or renames a file.

The method moves an OPC UA file to another directory, if a different directory has been specified. Otherwise, it renames a file, keeping it in the original directory.

Public Extension MethodMoveOrCopyOverloaded. Moves or copies an OPC UA file or directory to another directory, or renames a file or directory.

When the copyObject parameter is false, the method moves (or renames) the specified file or directory. When the copyObject parameter is true, the method copies the specified file or directory.

Public Extension MethodMoveOrCopyDirectoryOverloaded. Moves or copies an OPC UA directory to another directory, or renames a directory.

When the copyObject parameter is false, the method moves (or renames) the specified directory. When the copyObject parameter is true, the method copies the specified directory.

Public Extension MethodMoveOrCopyFileOverloaded. Moves or copies an OPC UA file to another directory, or renames a file.

When the copyObject parameter is false, the method moves (or renames) the specified file. When the copyObject parameter is true, the method copies the specified file.

Public Extension MethodOpenFileOpens an existing OPC UA file.
Public Extension MethodOpenOrCreateStreamOverloaded. Opens an existing OPC UA file, or creates a new OPC UA file if one does not exist, and returns a System.IO.Stream to access the file data.

If the file already exists, the method opens it. If the file does not exist, the method creates a new file. In both cases, the method returns a System.IO.Stream object that can be used to access the file data.

Public Extension MethodOpenOrCreateStreamWriterOverloaded. Creates or opens an OPC UA file for writing text via System.IO.StreamWriter.
Public Extension MethodOpenStreamOverloaded. Opens a System.IO.Stream on the specified OPC UA file.
Public Extension MethodOpenStreamReaderOverloaded. Opens an existing OPC UA text file for reading via System.IO.StreamReader.
Public Extension MethodOpenStreamWriterOverloaded. Opens an OPC UA file for writing text via System.IO.StreamWriter.
Public Extension MethodReadAllBytesOverloaded. Returns the contents of an OPC UA file as a byte array.
Public Extension MethodReadAllTextOverloaded. Returns the contents of an OPC UA text file as a System.String.
Public Extension MethodRenameOverloaded. Renames an OPC UA file or directory.
Public Extension MethodSetState<TNode>Sets the arbitrary object associated with the node.
Public Extension MethodWriteAllBytesOverloaded. Writes binary data to an OPC UA file.
Public Extension MethodWriteAllTextOverloaded. Writes text to an OPC UA file.
Top
See Also

Reference

EasyUAFileTransferClient Class
OpcLabs.EasyOpc.UA.FileTransfer Namespace

 

 

Copyright © 2004-2024 CODE Consulting and Development, s.r.o., Plzen. All rights reserved.

Documentation Home, Send Documentation Feedback. Technical Support