Difference between revisions of "GETDIR()"
From Lianjapedia
Yvonne.milne (Talk | contribs) (→Description) |
|||
(7 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
==Purpose== | ==Purpose== | ||
− | Function to display | + | Function to display a dialog allowing a directory to be selected and its name returned. |
− | + | ||
==Syntax== | ==Syntax== | ||
− | GETDIR([<expC1> | + | GETDIR([<expC1> [, <expC2> [, <expC3> [, <expN> [, <expL>]]]]]) |
− | + | ||
==See Also== | ==See Also== | ||
− | [[GETFILE()]], [[LOCFILE()]], [[PUTFILE()]] | + | [[DIRECTORY()]], [[GETFILE()]], [[LOCFILE()]], [[PUTFILE()]] |
− | + | ||
==Description== | ==Description== | ||
− | The GETDIR() function displays | + | The GETDIR() function displays a dialog allowing a directory to be selected and its name returned. The dialog allows navigation through directories and sub-directories. If a directory is selected, the GETDIR() function returns the name of that directory. If no directory is selected, the GETDIR() function returns an empty string "". |
− | + | {| class="wikitable" width="100%" | |
− | {| class="wikitable" | + | !width="30%"|Parameters||width=70%|Description |
− | !Parameters|| | + | |
|- | |- | ||
− | |<expC1>|| | + | |valign="top"|<expC1>||valign="top"|The starting directory |
|- | |- | ||
− | |<expC2>|| | + | |valign="top"|<expC2>||valign="top"|Ignored. |
|- | |- | ||
− | |<expC3>|| | + | |valign="top"|<expC3>||valign="top"|The text to display in the dialog title bar. |
|- | |- | ||
− | |< | + | |valign="top"|<expN>||valign="top|Ignored. |
+ | |- | ||
+ | |valign="top"|<expL>||valign="top|Ignored. | ||
|- | |- | ||
|} | |} | ||
− | |||
==Example== | ==Example== | ||
<code lang="recital"> | <code lang="recital"> | ||
− | + | cDirSelected = getdir("C:\Lianja","","Please select a directory") | |
</code> | </code> | ||
− | |||
− | |||
− | |||
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
+ | [[Category:UI_Functions]] |
Latest revision as of 10:37, 14 February 2020
Contents
Purpose
Function to display a dialog allowing a directory to be selected and its name returned.
Syntax
GETDIR([<expC1> [, <expC2> [, <expC3> [, <expN> [, <expL>]]]]])
See Also
DIRECTORY(), GETFILE(), LOCFILE(), PUTFILE()
Description
The GETDIR() function displays a dialog allowing a directory to be selected and its name returned. The dialog allows navigation through directories and sub-directories. If a directory is selected, the GETDIR() function returns the name of that directory. If no directory is selected, the GETDIR() function returns an empty string "".
Parameters | Description |
---|---|
<expC1> | The starting directory |
<expC2> | Ignored. |
<expC3> | The text to display in the dialog title bar. |
<expN> | Ignored. |
<expL> | Ignored. |
Example
cDirSelected = getdir("C:\Lianja","","Please select a directory")