API File.Delete: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Deletes the file or directory structure | Deletes the file or directory structure | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:File | |||
::Delete | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|STRING]] Filename'' | ''[[Variable types|STRING]] Filename'' | ||
:The file to delete | :The file to delete | ||
==Return value== | |||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
No additional information | No additional information | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Delete("filename")</pre> | ||
Revision as of 21:13, 11 May 2013
<sidebar>API contents</sidebar> Deletes the file or directory structure
Class hierarchy
- File
- Delete
Parameters
STRING Filename
- The file to delete
Return value
No additional information
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")