BBjInputD::getMask

Description

In BBj 4.0 and higher, this method returns the mask of the BBjInputD control.

Syntax

Return Value	Method
string	getMask()

Parameters

None.

Return Value

Returns the mask of the BBjInputD control. The mask is formatted according to the rules of the DATE() function.

Remarks

By default, the BBjInputD control is not in insert mode.

Example

REM Get the mask for an InputD 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$,$00010002$)

REM Add an InputD control that uses the current default mask, inserting
REM today's date when the user hits the restore key (normally ESCAPE)
myInputD! = myWindow!.addInputD(101,50,100,90,30,$080c$,"",$$,0,0)

REM Get the mask for the InputD control.
REM If the locale is "en_US", this will return "%Mz/%Dz/%Yz"
print "Mask is ",myInputD!.getMask()

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
RETURN