LOCFILE()

From Recital Documentation Wiki
Revision as of 15:35, 14 June 2011 by Yvonnemilne (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

Recital