Difference between revisions of "GETFILE()"

From Recital Documentation Wiki
Jump to: navigation, search
(Class)
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.
Line 38: Line 36:
  
 
==Products==
 
==Products==
Recital Mirage Server, Recital Terminal Developer
+
Recital  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]

Revision as of 16:11, 2 December 2009

Purpose

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


Syntax

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


See Also

PUTFILE()


Description

The GETFILE() 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 GETFILE() function returns the name of that file. If no file is selected, the GETFILE() 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 = getfile("prg","Please select a program")


Products

Recital