Difference between revisions of "LOCFILE()"
From Lianjapedia
Helen.george (Talk | contribs) |
|||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
==Purpose== | ==Purpose== | ||
Function to display an Open dialog allowing a filename to be selected and returned. | Function to display an Open dialog allowing a filename to be selected and returned. | ||
− | |||
==Syntax== | ==Syntax== | ||
LOCFILE([<expC1>] [,<expC2>] [,<expC3>] [,<expN1>]) | LOCFILE([<expC1>] [,<expC2>] [,<expC3>] [,<expN1>]) | ||
− | |||
==See Also== | ==See Also== | ||
[[GETFILE()]], [[PUTFILE()]] | [[GETFILE()]], [[PUTFILE()]] | ||
− | |||
==Description== | ==Description== | ||
The LOCFILE() function displays an Open dialog allowing a filename to be selected and returned. The dialog allows navigation through directories and shows a list of relevant files in that directory. The cursor keys, Return key and tab key can be used to navigate the different sections under a character mode environment. If the user selects a file, the LOCFILE() function returns the name of that file. If no file is selected, the LOCFILE() function returns an empty string "". | The LOCFILE() function displays an Open dialog allowing a filename to be selected and returned. The dialog allows navigation through directories and shows a list of relevant files in that directory. The cursor keys, Return key and tab key can be used to navigate the different sections under a character mode environment. If the user selects a file, the LOCFILE() function returns the name of that file. If no file is selected, the LOCFILE() function returns an empty string "". | ||
− | + | {| class="wikitable" width="100%" | |
− | {| class="wikitable" | + | !width="25%"|Parameters||width="20%"|Required||Description |
− | !Parameters||Required||Description | + | |
|- | |- | ||
− | |<expC1>||No||A file extension skeleton. If specified only files with this extension are shown | + | |valign="top"|<expC1>||valign="top"|No||A file extension skeleton. If specified only files with this extension are shown |
|- | |- | ||
− | |<expC2>||No||The text to display at the top of the dialog. If not specified, 'Open' is displayed. | + | |valign="top"|<expC2>||valign="top"|No||The text to display at the top of the dialog. If not specified, 'Open' is displayed. |
|- | |- | ||
− | |<expC3>||No||The text to display on the Ok button. This is ignored, the button is always | + | |valign="top"|<expC3>||valign="top"|No||The text to display on the Ok button. This is ignored, the button is always labelled 'Ok'. |
|- | |- | ||
− | |<expN1>||No||The buttons set to be displayed. This is ignored, the buttons are always Ok, Cancel, Reset, Back and Help. | + | |valign="top"|<expN1>||valign="top"|No||The buttons set to be displayed. This is ignored, the buttons are always Ok, Cancel, Reset, Back and Help. |
|- | |- | ||
|} | |} | ||
− | |||
==Example== | ==Example== | ||
Line 33: | Line 28: | ||
cProgramSelected = locfile("prg","Please select a program") | cProgramSelected = locfile("prg","Please select a program") | ||
</code> | </code> | ||
− | |||
==Products== | ==Products== | ||
− | + | Lianja | |
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:UI_Functions]] | [[Category:UI_Functions]] |
Latest revision as of 12:36, 1 February 2013
Purpose
Function to display an Open dialog allowing a filename to be selected and returned.
Syntax
LOCFILE([<expC1>] [,<expC2>] [,<expC3>] [,<expN1>])
See Also
Description
The LOCFILE() function displays an Open dialog allowing a filename to be selected and returned. The dialog allows navigation through directories and shows a list of relevant files in that directory. The cursor keys, Return key and tab key can be used to navigate the different sections under a character mode environment. If the user selects a file, the LOCFILE() function returns the name of that file. If no file is selected, the LOCFILE() function returns an empty string "".
Parameters | Required | Description |
---|---|---|
<expC1> | No | A file extension skeleton. If specified only files with this extension are shown |
<expC2> | No | The text to display at the top of the dialog. If not specified, 'Open' is displayed. |
<expC3> | No | The text to display on the Ok button. This is ignored, the button is always labelled 'Ok'. |
<expN1> | No | The buttons set to be displayed. This is ignored, the buttons are always Ok, Cancel, Reset, Back and Help. |
Example
cProgramSelected = locfile("prg","Please select a program")
Products
Lianja