Collapse all Symbian^3 Application Developer Library

UserHal Class Reference

class UserHal

A set of user side utility functions for acessing hardware related information.

Four of these functions are DEPRECATED and should NOT be used; some of these functions have replacements, but others do not; see the description of the individual functions.

The following functions are not deprecated, but are only used by Symbian OS as part of its internal implementation:

Public Member Functions
IMPORT_C TInt	CalibrationPoints ( TDigitizerCalibration &)
IMPORT_C TInt	DriveInfo ( TDes8 &)
IMPORT_C TInt	ExceptionId ( TInt &)
IMPORT_C TInt	ExceptionInfo ( TExcInfo &)
IMPORT_C TInt	FaultReason ( TInt &)
IMPORT_C TInt	MachineInfo ( TDes8 &)
IMPORT_C TInt	MemoryInfo ( TDes8 &)
IMPORT_C TInt	PageSizeInBytes ( TInt &)
IMPORT_C TInt	RestoreXYInputCalibration ( TDigitizerCalibrationType )
IMPORT_C TInt	RomInfo ( TDes8 &)
IMPORT_C TInt	SaveXYInputCalibration ()
IMPORT_C TInt	SetXYInputCalibration (const TDigitizerCalibration &)
IMPORT_C TInt	StartupReason ( TMachineStartupType &)
IMPORT_C TInt	SwitchOff ()
IMPORT_C TInt	TickPeriod ( TTimeIntervalMicroSeconds32 &)

Member Functions Documentation

CalibrationPoints(TDigitizerCalibration &)

IMPORT_C TInt

CalibrationPoints

(

TDigitizerCalibration &

aCalibration

)

[static]

Gets the points on the display that the user should point to in order to calibrate the digitiser (i.e. XY) input device.

Parameters

TDigitizerCalibration & aCalibration

A TDigitizerCalibration object that, on return, contains the appropriate information.

DriveInfo(TDes8 &)

IMPORT_C TInt

DriveInfo

(

TDes8 &

anInfo

)

[static]

Gets drive information.

TDriveInfoV1Buf TDriveInfoV1 TPckgBuf

Parameters

TDes8 & anInfo

A package buffer (TPckgBuf) containing a TDriveInfoV1 structure. On return, this structure will contain the drive information.

ExceptionId(TInt &)

IMPORT_C TInt

ExceptionId

(

TInt &

anId

)

[static]

Gets the exception Id that describes the type of fault when the kernel last faulted.

The Id is the value contained in TArmExcInfo::iExcCode.

TArmExcInfo::iExcCode TArmExcInfo

Parameters

TInt & anId

An integer that, on return, contains the exception Id.

ExceptionInfo(TExcInfo &)

IMPORT_C TInt

ExceptionInfo

(

TExcInfo &

aInfo

)

[static]

Gets the available exception information that describes the last kernel fault.

TExcInfo

Parameters

TExcInfo & aInfo

A TExcInfo structure that, on return, contains the available exception information.

FaultReason(TInt &)

IMPORT_C TInt

FaultReason

(

TInt &

aReason

)

[static]

Gets the reason why the kernel last faulted.

Kern::Fault()

Parameters

TInt & aReason

An integer that, on return, contains the reason code describing why the kernel faulted. This is the fault number passed in a call to Kern::Fault().

MachineInfo(TDes8 &)

IMPORT_C TInt

MachineInfo

(

TDes8 &

anInfo

)

[static]

Gets machine information.

Use HAL::Get() from the HAL library instead.

Parameters

TDes8 & anInfo

MemoryInfo(TDes8 &)

IMPORT_C TInt

MemoryInfo

(

TDes8 &

anInfo

)

[static]

Gets memory information.

HAL::Get()Use HAL::Get() from the HAL library instead with attributes EMemoryRAM, EMemoryRAMFree or EMemoryROM.

Parameters

TDes8 & anInfo

PageSizeInBytes(TInt &)

IMPORT_C TInt

PageSizeInBytes

(

TInt &

aSize

)

[static]

Gets the page size for this device.

Parameters

TInt & aSize

RestoreXYInputCalibration(TDigitizerCalibrationType)

IMPORT_C TInt

RestoreXYInputCalibration

(

TDigitizerCalibrationType

aType

)

[static]

Restores the digitiser (i.e. XY) input device calibration data.

capability: WriteDeviceData

Parameters

TDigitizerCalibrationType aType

A TDigitizerCalibration object that, on return, contains the calibration data.

RomInfo(TDes8 &)

IMPORT_C TInt

RomInfo

(

TDes8 &

anInfo

)

[static]

Gets ROM configuration information.

No replacement.

Parameters

TDes8 & anInfo

SaveXYInputCalibration()

IMPORT_C TInt

SaveXYInputCalibration

(

)

[static]

Saves the current digitiser (i.e. XY) input device calibration data.

SetXYInputCalibration(const TDigitizerCalibration &)

IMPORT_C TInt

SetXYInputCalibration

(

const TDigitizerCalibration &

aCalibration

)

[static]

Sets the calibration data for the digitiser (i.e. XY) input device.

TDigitizerCalibration

capability: WriteDeviceData

Parameters

const TDigitizerCalibration & aCalibration

The calibration data.

StartupReason(TMachineStartupType &)

IMPORT_C TInt

StartupReason

(

TMachineStartupType &

aReason

)

[static]

Gets the startup reason.

HAL::Get()Use HAL::Get() from the HAL library instead with attributes ESystemStartupReason.

Parameters

TMachineStartupType & aReason

SwitchOff()

IMPORT_C TInt

SwitchOff

(

)

[static]

Switches the device off.

capability: PowerMgmt

TickPeriod(TTimeIntervalMicroSeconds32 &)

IMPORT_C TInt

TickPeriod

(

TTimeIntervalMicroSeconds32 &

aPeriod

)

[static]

Gets the platform tick period.

Parameters

TTimeIntervalMicroSeconds32 & aPeriod

The tick period in microseconds.