BBjAPI::removeTimer

Description

In BBj 3.0 and higher, this method removes a timer previously created with BBjAPI::createTimer. 

Syntax

Return Value

Method

void

removeTimer(Object key)

Parameters

Variable

Description

key

Specifies a key that was previously used in a call to BBjAPI::createTimer.

Return Value

None.

Remarks

None.

Example

rem 'Timer event

SYSGUI = UNT
OPEN (SYSGUI)"X0"
bbj! = BBjAPI()
sysgui! = BBjAPI().getSysGui()
window! = sysgui!.addWindow(100,100,200,200,"Timer Test")
CALLBACK(ON_CLOSE,APP_CLOSE,sysgui!.getContext())
bbj!.createTimer(1,1,"one")
bbj!.createTimer("ten seconds",10,"ten")
bbj!.createTimer(20,20,"twenty")
process_events

APP_CLOSE:
    ESCAPE

one:
    print "second timer"
return

ten:
    print "10 second timer"
return

twenty:
    print "20 second timer"
    bbj!.removeTimer(20)
return

See Also

Timer Event

BBjAPI

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