12. Inter-Frame Communication Techniques : How You Can Communicate with an External Program Using External User Events : How You Can Register the External Event : RegisterUserEvent Method
 
Share this page                  
RegisterUserEvent Method
The RegisterUserEvent method registers a frame to receive the specified external event. The syntax follows:
FrameExec_var.RegisterUserEvent (eventname =
          varchar(32))
To specify the frame to be registered, you must reference the FrameExec variable for the running instance of the frame. (You cannot use the frame name because OpenROAD lets you open the same frame more than once.) For more information about how to reference the FrameExec variable, see SendUserEvent Method (see SendUserEvent Method).
To register the event for the frame that currently has the input focus, use the following syntax:
CurFrame.RegisterUserEvent(eventname = varchar(32))
eventname
Specifies the name of the user event. This must be the same as the name you use in the corresponding user event block (see UserEvent Event Block (see UserEvent Event Block)). This parameter is case sensitive.
The following example illustrates registering the external_update user event:
CurFrame.RegisterUserEvent(eventname =
    'external_update');