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

None.

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

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

Date Function for mask options

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.