Jump to content

API File.Delete: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import API changes
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
Line 10: Line 10:


==Parameters==
==Parameters==
[[Variable types|STRING]] ''Filename''
[[Variable Types|STRING]] ''Filename''
:The file to delete
:The file to delete




==Return value==
==Return value==
[[Variable types|BOOL]]
[[Variable Types|BOOL]]


Returns true if the operation is a success, else false
Returns true if the operation is a success, else false

Revision as of 11:09, 10 June 2013

<sidebar>API contents</sidebar> Deletes the file or directory structure

Class hierarchy

File

Delete

Parameters

STRING Filename

The file to delete


Return value

BOOL

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 information