BBjInputN::getRestore

Description

Returns the restore string of the BBjInputN control.

Syntax

Return Value	Method
string	getRestore()

Parameters

None.

Return Value

Returns the restore string of the BBjInputN control.

Remarks

The restore string is the text that appears when a user hits the restore key (usually ESC) or by calling the BBjInputN::restore method.

Example

rem 'Get the restore value for an InputN control

rem 'Obtain the instance of the BBjAPI object
let myAPI! = BBjAPI()

rem 'Open the SysGui device
SYSGUI = UNT
OPEN (SYSGUI) "X0"

rem 'Obtain the instance of the BBjSysGui object
let mySysGui! = myAPI!.getSysGui()

rem 'Set addWindow param values
X = 10
Y = 10
WIDTH = 200
HEIGHT = 200
TITLE$ = "BBj Window"

rem 'Set the current context
mySysGui!.setContext(0)

rem 'Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

rem 'Add an INPUTN control that limits input to 10 characters, and inserting
rem 'the value 1 when the user hits the restore key (normally ESCAPE)
myInputN! = myWindow!.addInputN(101,50,100,90,30,$0804$,"##,###,###.00",$$,1,0)

rem 'Get the restore value for an InputN control, this will return "1"
RESTORE$ = myInputN!.getRestore()

rem 'Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

rem 'Process Events
process_events

rem 'Callback routine called when the user closes the application window
APP_CLOSE:
release