Programming Guide - Actian

How You Can Communicate with an External Program Using External User EventsRegisterUserEvent MethodYou can register one frame for any number of external events. You can alsoregister more than one frame for the same external event.To register the frame to receive the external event, use the FrameExecRegisterUserEvent Method (see page 349). To remove an event from the list ofregistered events for the frame, use the FrameExec UnRegisterUserEventMethod (see page 349).The RegisterUserEvent method registers a frame to receive the specifiedexternal event. The syntax follows:FrameExec_var.RegisterUserEvent (eventname =varchar(32))To specify the frame to be registered, you must reference the FrameExecvariable for the running instance of the frame. (You cannot use the framename because OpenROAD lets you open the same frame more than once.) Formore information about how to reference the FrameExec variable, seeSendUserEvent Method (see page 339).To register the event for the frame that currently has the input focus, use thefollowing syntax:CurFrame.RegisterUserEvent(eventname = varchar(32))eventnameSpecifies the name of the user event. This must be the same as the nameyou use in the corresponding user event block (see UserEvent Event Block(see page 350)). This parameter is case sensitive.The following example illustrates registering the external_update user event:CurFrame.RegisterUserEvent(eventname ='external_update');UnRegisterUserEvent MethodThe UnRegisterUserEvent method removes one or all external events from thelist of registered events for a frame. The syntax follows:FrameExec_var.UnRegisterUserEvent(eventname =varchar(32))To specify the frame, you must reference the FrameExec variable for therunning instance of the frame. For more information about how to referencethe FrameExec variable, see SendUserEvent Method (see page 339).Inter-Frame Communication Techniques 349