User hardware abstraction layer


Section contents


Overview

Defined in

ce32base.oxh

Description

<TBS>


Methods provided

UserHalAutoSwitchOffBehavior - get auto switch off behavior

Usage

err% = UserHalAutoSwitchOffBehavior%:(BYREF behavior%)

Description

Get the auto switch off behavior.

Arguments
BYREF behavior% The current auto switch off behavior
Return value
err% An error code

UserHalAutoSwitchOffTime - get auto switch off time

Usage

err% = UserHalAutoSwitchOffTime%:(BYREF interval&)

Description

Get the auto switch off time.

Arguments
BYREF time& The current auto switch off time
Return value
err% An error code

UserHalBacklightBehavior - get backlight behavior

Usage

err% = UserHalBacklightBehavior%:(BYREF behavior%)

Description

Get the bavklight behavior.

Arguments
BYREF behavior% The current backlight behavior
Return value
err% An error code

UserHalBacklightOn - get backlight on state

Usage

err% = UserHalBacklightOn%:(BYREF state%)

Description

Get the bavklight on state.

Arguments
BYREF behavior% KTrue% if the backlight is currently on, otherwise returns KFalse%
Return value
err% An error code

UserHalBacklightOnTime - get backlight on time

Usage

err% = UserHalBacklightOnTime%:(BYREF interval&)

Description

Get the backlight on time.

Arguments
BYREF time& The current backlight on time
Return value
err% An error code

UserHalBatteryCapacity - get battery capacity

Usage

err% = UserHalBatteryCapacity%:(BYREF capacity&)

Description

Get the battery capacity.

Arguments
BYREF capacity& The current battery capacity
Return value
err% An error code

UserHalBatteryType - get battery type

Usage

err% = UserHalBatteryType%:(BYREF type&)

Description

Get the battery type.

Arguments
BYREF type& The current battery type
Return value
err% An error code

UserHalCaseCloseSwitchesOff - get case close switches off state

Usage

err% = UserHalCaseCloseSwitchesOff%:(BYREF state%)

Description

Get the case close switches off state.

Arguments
BYREF type& Set to KTrue% if closing the case switches off the machine, otherwise it returns KFalse%
Return value
err% An error code

UserHalCaseOpenSwitchesOn - get case open switches on state

Usage

err% = UserHalCaseOpenSwitchesOn%:(BYREF state%)

Description

Get the case open switches on state.

Arguments
BYREF type& Set to KTrue% if opening the case switches on the machine, otherwise it returns KFalse%
Return value
err% An error code

UserHalDisplayContrast - get display contrast

Usage

err% = UserHalDisplayContrast%:(BYREF contrast&)

Description

Get the display contrast.

Arguments
BYREF contrast& The current display contrast
Return value
err% An error code

UserHalHardwareInfo - get hardware information

Usage

err% = UserHalHardwareInfo%:(des&)

Description

Get the hardware information.

Arguments
des& A handle to a descriptor object
Return value
err% An error code

UserHalKeyClickEnabled - get key click enabled state

Usage

err% = UserHalKeyClickEnabled%:(BYREF state%)

Description

Get the key click enabled state.

Arguments
BYREF type& Set to KTrue% if key clicks are enabled, otherwise it returns KFalse%
Return value
err% An error code

UserHalKeyClickLoud - get key click loud state

Usage

err% = UserHalKeyClickLoud%:(BYREF state%)

Description

Get the key click loud state.

Arguments
BYREF type& Set to KTrue% if key clicks are loud, otherwise it returns KFalse%
Return value
err% An error code

UserHalKeyClickOverridden - get key click overridden state

Usage

err% = UserHalKeyClickOverridden%:(BYREF state%)

Description

Get the key click overridden state.

Arguments
BYREF type& Set to KTrue% if key clicks are overridden, otherwise it returns KFalse%
Return value
err% An error code

UserHalMaxDisplayContrast - get maximum display contrast

Usage

err% = UserHalMaxDisplayContrast%:(BYREF contrast&)

Description

Gets the maximu display contrast.

Arguments
BYREF contrast& The maximum display contrast
Return value
err% An error code

UserHalPageSizeInBytes - get page size in bytes

Usage

err% = UserHalPagesizeInBytes%:(BYREF size&)

Description

Gets the page size in bytes.

Arguments
BYREF size& The page size
Return value
err% An error code

UserHalPointerClickEnabled - get pointer click enabled state

Usage

err% = UserHalPointerClickEnabled%:(BYREF state%)

Description

Get the pointer click enabled state.

Arguments
BYREF type& Set to KTrue% if pointer click is enabled, otherwise it returns KFalse%
Return value
err% An error code

UserHalPointerClickLoud - get pointer click loud state

Usage

err% = UserHalPointerClickLoud%:(BYREF state%)

Description

Get the pointer click loud state.

Arguments
BYREF type& Set to KTrue% if pointer click is loud, otherwise it returns KFalse%
Return value
err% An error code

UserHalPointerSwitchesOn - get pointer switches on

Usage

err% = UserHalPointerSwitchesOn%:(BYREF state%)

Description

Get the pointer switches on state.

Arguments
BYREF type& Set to KTrue% if pointer switches on, otherwise it returns KFalse%
Return value
err% An error code

UserHalSetAutoSwitchOffBehavior - set auto switch off behavior

Usage

err% = UserHalSetAutoSwitchOffBehavior%:(behavior%)

Description

Sets the battery type.

Arguments
type& The switch off behavior
Return value
err% An error code

UserHalSetBacklightBehavior - set the backlight behavior

Usage

err% = UserHalSetBacklightBehavior%:(behavior%)

Description

Sets the behavior of the backlight.

Arguments
behavior% The backlight behavior to set
Return value
err% An error code

UserHalSetBacklightOn - set backlight on

Usage

err% = UserHalSetBacklightOn%:(bool%)

Description

Sets the backlight on or off.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetBatteryType - set battery type

Usage

err% = UserHalSetBatteryType%:(type&)

Description

Sets the battery type.

Arguments
type& The battery type
Return value
err% An error code

UserHalSetBeepEnabled - enable/disable beep

Usage

err% = UserHalSetBeepEnabled%:(bool%)

Description

Enables or disables the beep.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetBeepLoud - set beep loud

Usage

err% = UserHalSetBeepLoud%:(bool%)

Description

Sets the beep to loud.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetCaseCloseSwitchesOff - set case close switches off

Usage

err% = UserHalSetCaseCloseSwitchesOff%:(bool%)

Description

Enables/disables switches switch off when the case is closed.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetCaseOpenSwitchesOn - set case open switches on

Usage

err% = UserHalSetCaseOpenSwitchesOn%:(bool%)

Description

Enables/disables switches switch on when the case is opened.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetDisplayContrast - set display contrast

Usage

err% = UserHalSetDisplayContrast%:(contrast&)

Description

Sets the display contrast to contrast&.

Arguments
contrast& The display contrast to set
Return value
err% An error code

UserHalSetKeyClickEnabled - enable/disable key click

Usage

err% = UserHalSetKeyClickEnabled%:(bool%)

Description

Enables or disables the key click.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetKeyClickLoud - set key click loud

Usage

err% = UserHalSetKeyClickLoud%:(bool%)

Description

Sets the key click to loud.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetKeyClickOverridden - set key click overidden

Usage

err% = UserHalSetKeyClickOverridden%:(bool%)

Description

Sets the key click overidden state.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetPointerClickEnabled - set pointer click enabled

Usage

err% = UserHalSetPointerClickEnabled%:(bool%)

Description

Sets the pointer click enabled.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetPointerClickLoud - set pointer click loud

Usage

err% = UserHalSetPointerClickLoud%:(bool%)

Description

Sets the pointer click lound.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetPointerSwitchesOn - set pointer switches on

Usage

err% = UserHalSetPointerSwitchesOn%:(bool%)

Description

Sets the pointer switches on state.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetSoundDeviceEnabled - enable/disable sound devide

Usage

err% = UserHalSetSoundDeviceEnabled%:(bool%)

Description

Enables or disables the sound device.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetSoundDeviceLoud - set sound device loud

Usage

err% = UserHalSetSoundDeviceLoud%:(bool%)

Description

Sets the sound device to loud.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalSetSoundEnabled - set sound enabled

Usage

err% = UserHalSetSoundEnabled%:(bool%)

Description

Enable/disable sound.

Arguments
bool% A boolean value
Return value
err% An error code

UserHalStartupReason - get startup reason

Usage

err% = UserHalStartupReason%:(BYREF reason%)

Description

Sets the sound device to loud.

Arguments
BYREF reason% The starup reason
Return value
err% An error code