forked from livecode/livecode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaliasReference.xml
More file actions
47 lines (47 loc) · 2.62 KB
/
Copy pathaliasReference.xml
File metadata and controls
47 lines (47 loc) · 2.62 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
<doc>
<legacy_id>1078</legacy_id>
<name>aliasReference</name>
<type>function</type>
<syntax>
<example>the aliasReference of <i>aliasPath</i></example>
<example>aliasReference(<i>aliasPath</i>)</example>
</syntax>
<library></library>
<objects>
</objects>
<synonyms>
</synonyms>
<classification>
<category>Files, Folders, Resources</category>
</classification>
<references>
<command tag="create alias">create alias Command</command>
</references>
<history>
<introduced version="1.1">Added.</introduced>
</history>
<platforms>
<mac/>
<windows/>
<linux/>
<ios/>
<android/>
</platforms>
<classes>
<desktop/>
<server/>
<web/>
<mobile/>
</classes>
<security>
<disk access="???"/>
</security>
<summary><glossary tag="return">Returns</glossary> the name and location of the <keyword tag="file">file</keyword> or <property tag="defaultFolder">folder</property> that an <glossary tag="alias">alias</glossary>, <glossary tag="symbolic link">symbolic link</glossary>, or <glossary tag="shortcut">shortcut</glossary> refers to.</summary>
<examples>
<example>the aliasReference of "/Disk/Folder/Alias"</example>
<example>put the aliasReference of it into fileToOpen</example>
</examples>
<description>
<p>Use the <b>aliasReference</b> <control_st tag="function">function</control_st> to perform an operation on a <keyword tag="file">file</keyword> after the user has selected an <glossary tag="alias">alias</glossary>, <glossary tag="symbolic link">symbolic link</glossary>, or <glossary tag="shortcut">shortcut</glossary> to the <keyword tag="file">file</keyword>.</p><p/><p><b>Parameters:</b></p><p>The <i>aliasPath</i> is the location and name of the <glossary tag="alias">alias</glossary> whose referenced <keyword tag="file">file</keyword> or <property tag="defaultFolder">folder</property> you want to get. If you specify a name but not a location, LiveCode assumes the <keyword tag="file">file</keyword> is in the <property tag="defaultFolder">defaultFolder</property>.</p><p></p><p><b>Value:</b></p><p>The <b>aliasReference</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> the name and location of a <keyword tag="file">file</keyword> or <property tag="defaultFolder">folder</property>.</p><p/><p><b>Comments:</b></p><p>If the <i>aliasPath</i> does not exist, the <function tag="aliasReference">aliasReference</function> <control_st tag="function">function</control_st> returns <constant tag="empty">empty</constant> and the <function tag="result">result</function> is set to "can't get".</p>
</description>
</doc>