Extensions.File.DeleteFile

From emotive
Jump to navigation Jump to search

Classification

Name DeleteFile
Short Description Deletes a File on the specified path
Class Action
Extension OTX File extension
Group File related Actions
Exceptions FileLockException
FileNotFoundException
Checker Rules -
Standard Compliant Yes

OTL Syntax

File.DeleteFile(StringTerm path);

Description

The DeleteFile activity deletes a File on the specified path.

Properties

Name Data Type Class Default Cardinality Description
Path String Term - [1..1] The file to delete. The path parameter is permitted to specify relative or absolute path information. Relative path information is interpreted as relative to the OTX home directory. The format of the path (e.g. case-sensitive) depends on the operating system. The path should be defined by a URI.

OTL Examples

/// Local Declarations

File.FileWriteHandle FileWriteHandle1;

/// Flow

FileWriteHandle1 = File.OpenFileForWrite("file:///D:/abc/abc.txt", false, @Encoding:UTF-8);
File.CloseFile(FileWriteHandle1);
File.DeleteFile("file:///D:/abc/abc.txt");

See also

CloseFile
DeleteDirectory
SaveFile
WriteBytes
WriteFile
WriteLine