forked from livecode/livecode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdelete-file.xml
More file actions
74 lines (59 loc) · 3.08 KB
/
Copy pathdelete-file.xml
File metadata and controls
74 lines (59 loc) · 3.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<doc>
<legacy_id>1222</legacy_id>
<name>delete file</name>
<type>command</type>
<syntax>
<example>delete file <i>pathname</i></example>
</syntax>
<synonyms>
<synonym>clear file</synonym>
</synonyms>
<summary>Removes a <keyword tag="file">file</keyword> from the user's system.</summary>
<examples>
<example>delete file "/tmp/handlers.txt"</example>
<example>delete file "My Test.rev"</example>
</examples>
<history>
<introduced version="1.0">Added.</introduced>
<deprecated version=""></deprecated>
<removed version=""></removed>
<changed version="4.6.1">Added Support for Android</changed>
</history>
<objects>
</objects>
<platforms>
<mac/>
<windows/>
<linux/>
<ios/>
<android/>
</platforms>
<classes>
<desktop/>
<server/>
<web/>
<mobile/>
</classes>
<security>
<disk/>
</security>
<classification>
<category>Files, Folders, & Resources</category>
</classification>
<references>
<command tag="revDeleteFolder">revDeleteFolder Command</command>
<command tag="delete">delete Command</command>
<command tag="close file">close file Command</command>
<command tag="delete URL">delete URL Command</command>
</references>
<description>
<overview>Use the <b>delete file</b> <glossary tag="command">command</glossary> to clean up by removing a <keyword tag="file">file</keyword> you created.</overview>
<parameters>
<parameter>
<name>pathName</name>
<description>Specifies the name and location of the file. If you specify a name but not a location, LiveCode assumes the file is in the defaultFolder.</description>
</parameter> </parameters>
<value></value>
<comments>This command can also be used to remove files your stack did not create. Of course, a stack should not remove files and folders it did not create without obtaining explicit confirmation from the user.<p></p><p>If the file do not exist, is a folder, or for some other reason cannot be deleted, the <b>result</b> is set to "Can't delete that file.".</p><p></p><p><code tag=""><caution></code><code tag="">This</code> <glossary tag="command">command</glossary> cannot be undone, so be very certain before you use it. The <b>delete file</b> <glossary tag="command">command</glossary> removes the file completely from the user's system. It does not place the file in the Trash or Recycle Bin.</caution><p></p><p></p><note>iOS imposes strict controls over what you can and cannot access. Each application in iOS is stored in its own 'sandbox' folder (referred to as the home folder). An application is free to read and write files within this folder and its descendants, but it is not allowed to access anything outside of the 'sandbox'.</note><p></p><p></p><note>An Android application is installed on the phone in the form of its zip package. This means that any assets that are included are not available as discrete files in the native filesystem. In order to manage this the engine essentially 'virtualizes' the asset files you include, allowing (read-only) manipulation with all the standard LiveCode file and folder handling syntax.</note></comments>
</description>
</doc>