Difference between revisions of "API File.Delete"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Deletes the file or directory structure | Deletes the file or directory structure | ||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Filename'' |
:The file to delete | :The file to delete | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|BOOL]] |
| + | |||
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
| Line 28: | Line 29: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Delete("filename")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Delete("filename")</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Deletes the file or directory structure
Contents
Parameters
STRING Filename
- The file to delete
Return value
Returns true if the operation is a success, else false
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::File.Delete("filename")
No additional examples
