Class FileSystem
This class represents the FileSystem
domain of a Robot
controller.
Inherited Members
Namespace: ABB.Robotics.Controllers.FileSystemDomain
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public sealed class FileSystem : SDKControllerBoundBase, IComparable, INamedObject, IDisposable, IFileSystem
Fields
Prefix
Prefix for controller paths.
Declaration
public const string Prefix = "ctrl:"
Field Value
Type | Description |
---|---|
System.String |
Properties
LocalDirectory
Gets or set the directory on the local system.
Declaration
public string LocalDirectory { get; set; }
Property Value
Type | Description |
---|---|
System.String | The text associated to the local directory. |
RemoteDirectory
Gets or set the directory on the Robot Controller.
Declaration
public string RemoteDirectory { get; set; }
Property Value
Type | Description |
---|---|
System.String | The text associated to the remote directory. |
Methods
BeginCopyDirectory(String, String, AsyncCallback, Object)
Starts an async directory copy operation on the controller.
Declaration
public IAsyncResult BeginCopyDirectory(string source, string destination, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | source | Source directory. |
System.String | destination | Destination directory. |
System.AsyncCallback | callback | Callback method. |
System.Object | state | User defined state object. |
Returns
Type | Description |
---|---|
System.IAsyncResult | Result object. |
BeginCopyDirectory(String, String, Boolean, AsyncCallback, Object)
Starts an async directory copy operation on the controller.
Declaration
public IAsyncResult BeginCopyDirectory(string source, string destination, bool overwrite, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | source | Source directory. |
System.String | destination | Destination directory. |
System.Boolean | overwrite | True to overwrite any existing directory. |
System.AsyncCallback | callback | Callback method. |
System.Object | state | User defined state object. |
Returns
Type | Description |
---|---|
System.IAsyncResult | Result object. |
BeginCopyFile(String, String, AsyncCallback, Object)
Starts a new async file copy operation.
Declaration
public IAsyncResult BeginCopyFile(string source, string destination, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | source | Source file. |
System.String | destination | Destination file. |
System.AsyncCallback | callback | Callback. |
System.Object | state | User defined state object. |
Returns
Type | Description |
---|---|
System.IAsyncResult | Result object. |
BeginCopyFile(String, String, Boolean, AsyncCallback, Object)
Starts a new async file copy operation.
Declaration
public IAsyncResult BeginCopyFile(string source, string destination, bool overwrite, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | source | Source file. |
System.String | destination | Destination file. |
System.Boolean | overwrite | True to overwrite any existing file. |
System.AsyncCallback | callback | Callback. |
System.Object | state | User defined state object. |
Returns
Type | Description |
---|---|
System.IAsyncResult | Result object. |
BeginCreateDirectory(String, AsyncCallback, Object)
Starts a CreateDirectory operation on the controller.
Declaration
public IAsyncResult BeginCreateDirectory(string name, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of directory. |
System.AsyncCallback | callback | Completion callback. |
System.Object | state | User state object. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \Result object. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
BeginDirectoryExists(String, AsyncCallback, Object)
Starts a directory exists operation.
Declaration
public IAsyncResult BeginDirectoryExists(string path, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path of directory. |
System.AsyncCallback | callback | Callback. |
System.Object | state | State. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \Result object. |
Remarks
Requires the ReadFtp grant.
BeginFileExists(String, AsyncCallback, Object)
Starts a begin file operation.
Declaration
public IAsyncResult BeginFileExists(string path, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path to file. |
System.AsyncCallback | callback | Callback. |
System.Object | state | State. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \ \ |
Remarks
Requires the ReadFtp grant.
BeginGetDirectory(String, String, Boolean, AsyncCallback, Object)
Starts a get operation for a complete directory.
Declaration
public IAsyncResult BeginGetDirectory(string remoteDirectory, string localDirectory, bool overwrite, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteDirectory | Name of remote directory. |
System.String | localDirectory | Name of local directory. |
System.Boolean | overwrite | true to overwrite local if exists. |
System.AsyncCallback | callback | Callback. |
System.Object | state | State. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \ \ |
Remarks
Requires the ReadFtp grant.
BeginGetFile(String, String, Boolean, AsyncCallback, Object)
Starts a get file operation.
Declaration
public IAsyncResult BeginGetFile(string remoteFile, string localFile, bool overwrite, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteFile | Remote file. |
System.String | localFile | Local file. |
System.Boolean | overwrite | Flag indicating if to overwrite any existing file. |
System.AsyncCallback | callback | Callback method. |
System.Object | state | State object. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \Result object. |
Remarks
Requires the ReadFtp grant.
BeginListDirectory(String, AsyncCallback, Object)
Starts a list directory operation.
Declaration
public IAsyncResult BeginListDirectory(string filter, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | filter | Filter expression. |
System.AsyncCallback | callback | Callback method. |
System.Object | state | State object. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \ \ |
Remarks
Requires the ReadFtp grant.
BeginPutDirectory(String, String, Boolean, AsyncCallback, Object)
Starts a put directory operation.
Declaration
public IAsyncResult BeginPutDirectory(string localDirectory, string remoteDirectory, bool overwrite, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | localDirectory | Local directory. |
System.String | remoteDirectory | Remote directory. |
System.Boolean | overwrite | true to overwrite remote directory if already present. |
System.AsyncCallback | callback | Callback. |
System.Object | state | State. |
Returns
Type | Description |
---|---|
System.IAsyncResult |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
BeginPutFile(String, String, Boolean, AsyncCallback, Object)
Starts a put file operation.
Declaration
public IAsyncResult BeginPutFile(string localFile, string remoteFile, bool overwrite, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | localFile | Local file. |
System.String | remoteFile | Remote file. |
System.Boolean | overwrite | True to overwrite if already present. |
System.AsyncCallback | callback | Callback method. |
System.Object | state | State. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \Result object. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
BeginRemoveDirectory(String, Boolean, AsyncCallback, Object)
Starts an remove directory operation.
Declaration
public IAsyncResult BeginRemoveDirectory(string path, bool recursive, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path of directory. |
System.Boolean | recursive | True, to remove directory recursively. |
System.AsyncCallback | callback | Callback. |
System.Object | state | State. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \Result object. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
BeginRemoveFile(String, AsyncCallback, Object)
Starts a remove file operation.
Declaration
public IAsyncResult BeginRemoveFile(string path, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | \File to remove. |
System.AsyncCallback | callback | Callback. |
System.Object | state | State. |
Returns
Type | Description |
---|---|
System.IAsyncResult | \Result object. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
BeginRename(String, String, AsyncCallback, Object)
Starts a new rename operation.
Declaration
public IAsyncResult BeginRename(string path, string name, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path to file or directory to rename. |
System.String | name | New name. |
System.AsyncCallback | callback | Callback. |
System.Object | state | State object. |
Returns
Type | Description |
---|---|
System.IAsyncResult | AsyncResult object. |
Remarks
CopyDirectory(String, String)
Copies a directory locally on the controller.
Declaration
public void CopyDirectory(string source, string destination)
Parameters
Type | Name | Description |
---|---|---|
System.String | source | Source directory. |
System.String | destination | Destination directory. |
Remarks
CopyDirectory(String, String, Boolean)
Copies a directory locally on the controller.
Declaration
public void CopyDirectory(string source, string destination, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | source | Source directory. |
System.String | destination | Destination directory. |
System.Boolean | overwrite | True replace any exists directory. |
Remarks
CopyFile(String, String)
Copies a file locally on the controller, from the source to the destination.
Declaration
public void CopyFile(string source, string destination)
Parameters
Type | Name | Description |
---|---|---|
System.String | source | Source to copy. |
System.String | destination | Destination. |
Remarks
CopyFile(String, String, Boolean)
Copies a file locally on the controller, from the source to the destination.
Declaration
public void CopyFile(string source, string destination, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | source | Source to copy. |
System.String | destination | Destination. |
System.Boolean | overwrite | True to overwrite any existing \file. |
Remarks
CreateDirectory(String)
Creates a directory on the Robot Controller.
Declaration
public ControllerDirectoryInfo CreateDirectory(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the directory to create. |
Returns
Type | Description |
---|---|
ControllerDirectoryInfo |
Remarks
The directory is created under the directorys specified by the property RemoteDirectory
DirectoryExists(String)
Verifies that a directory exists.
Declaration
public bool DirectoryExists(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path to directory. |
Returns
Type | Description |
---|---|
System.Boolean | True if the directory exist. |
Remarks
Requires the ReadFtp grant.
EndCopyDirectory(IAsyncResult)
Ends an async directory copy operation.
Declaration
public void EndCopyDirectory(IAsyncResult result)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | result | Result object from BeginCopyFile operation. |
EndCopyFile(IAsyncResult)
Ends an async file copy operation.
Declaration
public void EndCopyFile(IAsyncResult result)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | result | Result object from BeginCopyFile operation. |
EndCreateDirectory(IAsyncResult)
End an async directory creation operation.
Declaration
public ControllerDirectoryInfo EndCreateDirectory(IAsyncResult result)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | result | AsyncResult from start operation. |
Returns
Type | Description |
---|---|
ControllerDirectoryInfo | Info object for directory. |
EndDirectoryExists(IAsyncResult)
Ends the directory exists operation.
Declaration
public bool EndDirectoryExists(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | Result from BeginDirectoryExists. |
Returns
Type | Description |
---|---|
System.Boolean | True if the file exists, otherwise false. |
EndFileExists(IAsyncResult)
Ends a FileExists operation.
Declaration
public bool EndFileExists(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | AsyncResult. |
Returns
Type | Description |
---|---|
System.Boolean | true if file exists. |
EndGetDirectory(IAsyncResult)
Ends a GetDirectory operation.
Declaration
public string EndGetDirectory(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | Async resul.t |
Returns
Type | Description |
---|---|
System.String | Path to local directory. |
EndGetFile(IAsyncResult)
Ends a get file operation.
Declaration
public string EndGetFile(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | Async result. |
Returns
Type | Description |
---|---|
System.String | Path to local file. |
EndListDirectory(IAsyncResult)
Ends a list directory operation.
Declaration
public ControllerFileSystemInfo[] EndListDirectory(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | Async result. |
Returns
Type | Description |
---|---|
ControllerFileSystemInfo[] | The matching file entries. |
EndPutDirectory(IAsyncResult)
Ends a put directory operation.
Declaration
public string EndPutDirectory(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | Async result. |
Returns
Type | Description |
---|---|
System.String | Path to remote directory. |
EndPutFile(IAsyncResult)
Ends an PutFile operation.
Declaration
public string EndPutFile(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | Async result. |
Returns
Type | Description |
---|---|
System.String | Destination path. |
EndRemoveDirectory(IAsyncResult)
Ends an RemoveDirectory operation.
Declaration
public void EndRemoveDirectory(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | Result. |
EndRemoveFile(IAsyncResult)
Ends an RemoveFile operation.
Declaration
public void EndRemoveFile(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | Result. |
EndRename(IAsyncResult)
Ends the rename operation.
Declaration
public string EndRename(IAsyncResult ar)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | ar | AsyncResult. |
Returns
Type | Description |
---|---|
System.String | New path. |
FileExists(String)
Checks if the file exists.
Declaration
public bool FileExists(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of file. |
Returns
Type | Description |
---|---|
System.Boolean | true if file exists, otherwise false. |
Remarks
Requires the ReadFtp grant.
GetDirectory(String)
Get a remote directory, creates a local directory with the same name as the remote.
Declaration
public void GetDirectory(string remoteDirectory)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteDirectory | Remote directory. |
Remarks
Requires the ReadFtp grant.
GetDirectory(String, Boolean)
Get a remote directory, creates a local directory with the same name as the remote.
Declaration
public void GetDirectory(string remoteDirectory, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteDirectory | Remote directory. |
System.Boolean | overwrite | true to overwrite any existing local directory. |
Remarks
Requires the ReadFtp grant.
GetDirectory(String, String)
Gets a complete directory recursively.
Declaration
public void GetDirectory(string remoteDirectory, string localDirectory)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteDirectory | Name of remote directory. |
System.String | localDirectory | Name of local directory. |
Remarks
Requires the ReadFtp grant.
GetDirectory(String, String, Boolean)
Gets a complete directory recursively.
Declaration
public void GetDirectory(string remoteDirectory, string localDirectory, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteDirectory | Name of remote directory. |
System.String | localDirectory | Name of local directory. |
System.Boolean | overwrite | true to overwrite any existing local directories. |
Remarks
Requires the ReadFtp grant.
GetDirectoryAccessTime(String)
Gets the accesstime for a directory.
Declaration
public DateTime GetDirectoryAccessTime(string directory)
Parameters
Type | Name | Description |
---|---|---|
System.String | directory | Directory to get access time for. |
Returns
Type | Description |
---|---|
System.DateTime | DateTime for last access. |
Remarks
Requires the ReadFtp grant.
GetDirectoryAttributes(String)
Gets the attributes for a directory.
Declaration
public FileAttributes GetDirectoryAttributes(string directory)
Parameters
Type | Name | Description |
---|---|---|
System.String | directory | Name of directory. |
Returns
Type | Description |
---|---|
System.IO.FileAttributes | Attribute of directory. |
Remarks
Requires the ReadFtp grant.
GetDirectoryCreationTime(String)
Gets the creation time for a directory.
Declaration
public DateTime GetDirectoryCreationTime(string directory)
Parameters
Type | Name | Description |
---|---|---|
System.String | directory | Name of directory. |
Returns
Type | Description |
---|---|
System.DateTime | Time of creation. |
Remarks
Requires the ReadFtp grant.
GetDirectoryWriteTime(String)
Gets the last write time for a directory.
Declaration
public DateTime GetDirectoryWriteTime(string directory)
Parameters
Type | Name | Description |
---|---|---|
System.String | directory | Name of directory. |
Returns
Type | Description |
---|---|
System.DateTime | Last write time. |
Remarks
Requires the ReadFtp grant.
GetFile(String)
Gets a file from the Robot Controller and stores it on the local system. Stores file locally with same name as on the controller.
Declaration
public void GetFile(string remoteFile)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteFile | Name of a file to retrieve from the Robot Controller. |
Remarks
Requires the ReadFtp grant.
GetFile(String, Boolean)
Gets a file from the Robot Controller and stores it on the local system. Stores file locally with same name as on the controller.
Declaration
public void GetFile(string remoteFile, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteFile | Name of a file to retrieve from the Robot Controller. |
System.Boolean | overwrite | true, to overwrite local file. |
Remarks
Requires the ReadFtp grant.
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file to overwrite is Read-only. |
GetFile(String, String)
Gets a file from the Robot Controller and stores it on the local system.
Declaration
public void GetFile(string remoteFile, string localFile)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteFile | Name of a file to retrieve from the Robot Controller. |
System.String | localFile | Name of the file to create in the local file system. |
Remarks
Requires the ReadFtp grant.
GetFile(String, String, Boolean)
Gets a file from the Robot Controller and stores it on the local system.
Declaration
public void GetFile(string remoteFile, string localFile, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteFile | Name of a file to retrieve from the Robot Controller. |
System.String | localFile | Name of the file to create on the local system. |
System.Boolean | overwrite | true, to overwrite local file. |
Remarks
Requires the ReadFtp grant.
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file to overwrite is Read-only. |
GetFileAccessTime(String)
Gets the last access time for a file.
Declaration
public DateTime GetFileAccessTime(string file)
Parameters
Type | Name | Description |
---|---|---|
System.String | file | Name of remote file. |
Returns
Type | Description |
---|---|
System.DateTime | DateTime for last access. |
Remarks
Requires the ReadFtp grant.
GetFileAttributes(String)
Gets the file attributes for a remote file.
Declaration
public FileAttributes GetFileAttributes(string file)
Parameters
Type | Name | Description |
---|---|---|
System.String | file | Name of remote file. |
Returns
Type | Description |
---|---|
System.IO.FileAttributes | FileAttributes for file. |
Remarks
Requires the ReadFtp grant.
GetFileCreationTime(String)
Get the time of creation for a file.
Declaration
public DateTime GetFileCreationTime(string file)
Parameters
Type | Name | Description |
---|---|---|
System.String | file | Name of remote file. |
Returns
Type | Description |
---|---|
System.DateTime | Time of creation. |
Remarks
Requires the ReadFtp grant.
GetFilesAndDirectories(String)
Returns the info objects of files and directories on the controller file system that matches the specified search pattern. To get the list of files and directories use the search pattern "*".
Declaration
public ControllerFileSystemInfo[] GetFilesAndDirectories(string searchPattern)
Parameters
Type | Name | Description |
---|---|---|
System.String | searchPattern | The search string to match against the names of files in path. |
Returns
Type | Description |
---|---|
ControllerFileSystemInfo[] | An array of ControllerFileSystemInfo objects matching the search criteria. |
Remarks
Requires the ReadFtp grant.
GetFileWriteTime(String)
Gets the last write time for the remote file.
Declaration
public DateTime GetFileWriteTime(string file)
Parameters
Type | Name | Description |
---|---|---|
System.String | file | Name of remote file. |
Returns
Type | Description |
---|---|
System.DateTime | Last write time. |
Remarks
Requires the ReadFtp grant.
GetLocalPath(String)
Gets the combined path from name and LocalDirectory.
Declaration
public string GetLocalPath(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Filename. |
Returns
Type | Description |
---|---|
System.String | Complete local path. |
GetRemotePath(String)
Gets the combined path from name and RemoteDirectory.
Declaration
public string GetRemotePath(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of file or directory. |
Returns
Type | Description |
---|---|
System.String | Combined path. |
GetSize(String)
Gets the size of a file.
Declaration
public long GetSize(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of file. |
Returns
Type | Description |
---|---|
System.Int64 | The size of the file in bytes. |
Remarks
Requires the ReadFtp grant.
GetStorageDevices()
Gets all available drives.
Declaration
public StorageDeviceInfo[] GetStorageDevices()
Returns
Type | Description |
---|---|
StorageDeviceInfo[] | Array of available drives. |
PutDirectory(String)
Puts a directory from the local computer to the filesytem of the controller.
Declaration
public void PutDirectory(string localDirectory)
Parameters
Type | Name | Description |
---|---|---|
System.String | localDirectory | Name of local directory. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
PutDirectory(String, Boolean)
Puts a directory from the local computer to the filesytem of the controller.
Declaration
public void PutDirectory(string localDirectory, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | localDirectory | Name of local directory. |
System.Boolean | overwrite | true to overwrite remote directory if already present. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
PutDirectory(String, String)
Puts a directory from the local computer to the filesytem of the controller.
Declaration
public void PutDirectory(string localDirectory, string remoteDirectory)
Parameters
Type | Name | Description |
---|---|---|
System.String | localDirectory | Name of local directory. |
System.String | remoteDirectory | Name of remote directory. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
PutDirectory(String, String, Boolean)
Puts a directory from the local computer to the filesytem of the controller.
Declaration
public void PutDirectory(string localDirectory, string remoteDirectory, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | localDirectory | Name of local directory. |
System.String | remoteDirectory | Name of remote directory. |
System.Boolean | overwrite | true to overwrite remote directory if already present. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
PutFile(String)
Stores a file from the local system to the Robot Controller.
Declaration
public void PutFile(string localFile)
Parameters
Type | Name | Description |
---|---|---|
System.String | localFile | Name of a file to send from the local system. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
PutFile(String, Boolean)
Stores a file from the local system to the Robot Controller.
Declaration
public void PutFile(string localFile, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | localFile | Name of a file to send from the local system. |
System.Boolean | overwrite | true, to overwrite existing file. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
PutFile(String, String)
Stores a file from the local system to the Robot Controller.
Declaration
public void PutFile(string localFile, string remoteFile)
Parameters
Type | Name | Description |
---|---|---|
System.String | localFile | Name of a file to send from the local system. |
System.String | remoteFile | Name of the file to create on the Robot Controller. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
PutFile(String, String, Boolean)
Stores a file from the local system to the Robot Controller.
Declaration
public void PutFile(string localFile, string remoteFile, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | localFile | Name of a file to send from the local system. |
System.String | remoteFile | Name of the file to create on the Robot Controller. |
System.Boolean | overwrite | true, to overwrite existing file. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
RemoveDirectory(String)
Removes the specified directory from Robot Controller.
Declaration
public void RemoveDirectory(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path of the directory to be removed. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
RemoveDirectory(String, Boolean)
Removes the specified directory from Robot Controller.
Declaration
public void RemoveDirectory(string path, bool recursive)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path of the directory to be removed. |
System.Boolean | recursive | True to remove all directories recursively. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
RemoveFile(String)
Deletes the specified file from the Robot Controller.
Declaration
public void RemoveFile(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Name of the file to remove. |
Remarks
Requires the UAS_WRITE_FTP WriteFtp.
RenameDirectory(String, String)
Renames the specified directory on the Robot Controller.
Declaration
public void RenameDirectory(string existingDirectory, string newName)
Parameters
Type | Name | Description |
---|---|---|
System.String | existingDirectory | Name of the directory to be renamed. |
System.String | newName | New name of the directory. |
Remarks
RenameFile(String, String)
Renames the specified file on the Robot Controller.
Declaration
public void RenameFile(string existingFile, string newName)
Parameters
Type | Name | Description |
---|---|---|
System.String | existingFile | Name of the file to be renamed. |
System.String | newName | New name of the file. |