%HI_GetMasterEnable, %HI_SetMasterEnable functions

Function

The %HI_SetMasterEnable function disables the access to the object (overloads %HI_SetEnable) / cancels the overloading and enables to control the displaying of graphic object by %HI_SetEnable (control function).

The %HI_GetMasterEnable function gets the current status of overloading of object that is set by %HI_GetMasterEnable.

Declaration

%HI_SetMasterEnable(
   INT in refId,
   BOOL in bEnable
 )
 
 
 BOOL %HI_GetMasterEnable(
   INT in refId
 )

Parameters

refId	Reference to graphic object (reference variable).
bEnable	@TRUE - enables of graphic object @FALSE - disables of graphic object

Description

%HI_SetMasterEnable disables the graphic objects or tab of the object Windows control - Tabs - the parameter refId defines the name of the reference variable for particular graphic object or the tab. When bEnable parameter is @FALSE, it overloads the %HI_SetEnable function (disables its functionality).

%HI_GetMasterEnable gets the current status of object overloading that is set by %HI_SetMasterEnable. The return value @TRUE does not mean that the object is enabled but the object is controlled by %HI_SetEnable function. @FALSE means the controlling of object by %HI_SetEnable function is blocked and the object is disabled.

The behavior of Master functions is described in the chapter Master functions.

Example

 ENTRY OnLogOn(IN TEXT _userName, IN BOOL _bLogOn)
   IF _bLogOn THEN
 
    ;when a user is logged on, the object is enabled
    %HI_SetMasterEnable(_Text,@TRUE)
  ELSE
 
    ;when a user is logged off, the access to object is disabled
    %HI_SetMasterEnable(_Text,@FALSE)
  ENDIF
 END OnLogOn

Note

This function is also in %HIX_ version.