Difference between revisions of "LOCFILE()"

From Lianjapedia
Jump to: navigation, search
m (Text replace - "Recital" to "Lianja")
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"
 
{| class="wikitable"
Line 27: Line 23:
 
|-
 
|-
 
|}
 
|}
 
  
 
==Example==
 
==Example==
Line 33: Line 28:
 
cProgramSelected = locfile("prg","Please select a program")
 
cProgramSelected = locfile("prg","Please select a program")
 
</code>
 
</code>
 
  
 
==Products==
 
==Products==

Revision as of 12:54, 11 December 2012

Purpose

Function to display an Open dialog allowing a filename to be selected and returned.

Syntax

LOCFILE([<expC1>] [,<expC2>] [,<expC3>] [,<expN1>])

See Also

GETFILE(), PUTFILE()

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 labeled '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