OnCloseHI picture event

Declaration

ENTRY OnCloseHI (BOOL _bClose)
 ; script actions
END OnCloseHI

Parameters

_bClose Required input-output parameter of BOOL type.

Description

The picture event is being generated by the HI when user attempts to close it. The picture event handler must set the parameter _bClose to a value and this is the reaction to user's action. Before terminating the picture event handler, if the parameter is set to:

@TRUE - the HI will be closed
@FALSE - the HI will not be closed

Example

; evet handler: Attempt to close HI
ENTRY OnCloseHI  (BOOL   _bClose)
  _bClose := @FALSE ; refusing to close HI
END OnCloseHI

A picture a OnClose handler defined like this can not be closed.

Note

The event handler can be used e.g. for checking parameters defined by the user. If the handler doesn't change the value of the parameter _bClose, the picture will be closed.

Picture event handler
Picture events