Difference between revisions of "API File.Delete"

Latest revision as of 11:55, 16 January 2023

	Delete
Deletes the file or directory structure
- STRING	Filename
The file to delete
- BOOL	Return

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Deletes the file or directory structure
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Delete'''
+|-
+| colspan="2" | Deletes the file or directory structure&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Filename
+|-
+| colspan="2" | The file to delete&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|STRING]] Filename''
-:The file to delete
-===Return value===
-[[Variable types|BOOL]]
-No additional information
-===Detailed description===
+==Examples==
-''No additional information''
+===Calling in a calculation===
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: <pre class="brush:[C]">result = ::File.Delete("filename")</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Delete("filename")</pre>