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 HI process with an OnCloseHI event handler defined in this way cannot be closed.

Note

The OnCloseHI event should be defined in only one of the currently opened pictures in HI. If more than one such event is defined, none of them will be executed, and HI will be closed in the standard manner—that is, as if no OnCloseHI event had been defined.

The presence of multiple pictures with a defined OnCloseHI event handler is indicated to the user via an error dialog.

Related pages:

Picture event handler
Picture events