Difference between revisions of "Extensions.File.DeleteDirectory"
Jump to navigation
Jump to search
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | File.DeleteDirectory(StringTerm); | + | File.DeleteDirectory(StringTerm path); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''DeleteDirectory''' activity deletes a Directory on the specified path. | + | The '''DeleteDirectory''' activity deletes a Directory on the specified path. When deleting a directory, its contents will be deleted recursively. |
== Properties == | == Properties == | ||
Latest revision as of 09:56, 2 November 2018
Classification
| Name | DeleteDirectory |
| Short Description | Deletes a Directory 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.DeleteDirectory(StringTerm path);Description
The DeleteDirectory activity deletes a Directory on the specified path. When deleting a directory, its contents will be deleted recursively.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Path | String | Term | - | [1..1] | The directory 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.DeleteDirectory("D:/abc");See also
CloseFile
DeleteFile
SaveFile
WriteBytes
WriteFile
WriteLine
