A set of static functions to get and set hardware attributes. More...

#include <hal.h>

Inheritance diagram for HAL:

Classes
struct	SEntry
	Defines an entry in the array that is returned in a call to HAL::GetAll(). More...

Public Types
enum	TEntryProperty { EEntryValid =0x1 , EEntryDynamic =0x2 }
	Synonyms for the attribute properties HALData::TAttributeProperty, and used in SEntry. More...

Static Public Member Functions
static IMPORT_C TInt	Get (TAttribute aAttribute, TInt &aValue)
	Gets the value of the specified HAL attribute.

static IMPORT_C TInt	Set (TAttribute aAttribute, TInt aValue)

static IMPORT_C TInt	GetAll (TInt &aNumEntries, SEntry *&aData)
	Gets all HAL attributes, and their properties.

static IMPORT_C TInt	Get (TInt aDeviceNumber, TAttribute aAttribute, TInt &aValue)
	Gets the value of the specified HAL attribute.

static IMPORT_C TInt	Set (TInt aDeviceNumber, TAttribute aAttribute, TInt aValue)

Detailed Description

A set of static functions to get and set hardware attributes.

See also: HALData

API status: Published to platform partners. Released API.

Definition at line 41 of file hal.h.

Member Enumeration Documentation

◆ TEntryProperty

enum HAL::TEntryProperty

Synonyms for the attribute properties HALData::TAttributeProperty, and used in SEntry.

Enumerator
EEntryValid	When set, means that an attribute is meaningful on this device.
EEntryDynamic	When set, means that an attribute is modifiable.

Definition at line 49 of file hal.h.

Member Function Documentation

◆ Get() [1/2]

static IMPORT_C TInt HAL::Get	(	TAttribute	aAttribute,
		TInt &	aValue
	)

static

Gets the value of the specified HAL attribute.

Parameters

aAttribute	The HAL attribute.
aValue	On successful return, contains the attribute value. Some attributes may accept aValue as an input as well, to select one of several alternate values. See the documentation for the individual HAL attributes for details of this.

Returns: KErrNone, if successful; KErrNotSupported, if the attribute is not defined in the list of attributes, or is not meaningful for this device. KErrArgument, if aValue was invalid (for attributes which take an argument).

See also: HALData::TAttribute; HALData::TAttributeProperty

◆ Get() [2/2]

static IMPORT_C TInt HAL::Get	(	TInt	aDeviceNumber,
		TAttribute	aAttribute,
		TInt &	aValue
	)

static

Gets the value of the specified HAL attribute.

Parameters

aDeviceNumber	The device number. (eg: screen number)
aAttribute	The HAL attribute.
aValue	On successful return, contains the attribute value. Some attributes may accept aValue as an input as well, to select one of several alternate values. See the documentation for the individual HAL attributes for details of this.

Returns: KErrNone, if successful; KErrNotSupported, if the attribute is not defined in the list of attributes, or is not meaningful for this device. KErrArgument, if aValue was invalid (for attributes which take an argument).

See also: HALData::TAttribute; HALData::TAttributeProperty

◆ GetAll()

static IMPORT_C TInt HAL::GetAll	(	TInt &	aNumEntries,
		SEntry *&	aData
	)

static

Gets all HAL attributes, and their properties.

For attributes that are not meaningful on this device (ie. those which have not been defined in the config.hcf file), the attribute value and its associated property value are set to zero in the returned array.

Attributes for which multiple values can be retrieved ie. EDisplayIsPalettized, EDisplayBitsPerPixel, EDisplayOffsetToFirstPixel, EDisplayOffsetBetweenLines, and EDisplayPaletteEntry will also be zero in the returned array.

Attributes that allocate resources and open handles are also not returned by this API. Their value and property values will be set to zero in the returned array. Use HAL::Get() for these attributes.

Parameters

aNumEntries	On successful return, contains the total number of HAL attributes. If the function returns KErrNoMemory, this value is set to zero.
aData	On successful return, contains a pointer to an array of SEntry objects, each of which contains an attribute value and its property value. Note that the property value is defined by the HAL::TEntry synonym. If the function returns KErrNoMemory, this pointer is set to NULL.

Returns: KErrNone, if succesful; KErrNoMemory, if there is insufficient memory.

◆ Set() [1/2]

static IMPORT_C TInt HAL::Set	(	TAttribute	aAttribute,
		TInt	aValue
	)

static

Sets the specified HAL attribute.

@param aAttribute The HAL attribute.
@param aValue      The attribute value.

@return  KErrNone, if successful;
         KErrNotSupported, if the attribute is not defined in the list
         of attributes, or is not meaningful for this device, or is
         not settable.

@see HALData::TAttribute
@see HALData::TAttributeProperty

for individual attributes in TAttribute

API status: Required capability: WriteDeviceData or other capability specified

Parameters

aAttribute	The HAL attribute.
aValue	The attribute value.

(generated from Symbian Developer Library)

◆ Set() [2/2]

static IMPORT_C TInt HAL::Set	(	TInt	aDeviceNumber,
		TAttribute	aAttribute,
		TInt	aValue
	)

static

Sets the specified HAL attribute.

@param aDeviceNumber The device number. (eg: screen number)
@param aAttribute The HAL attribute.
@param aValue      The attribute value.

@return  KErrNone, if successful;
         KErrNotSupported, if the attribute is not defined in the list
         of attributes, or is not meaningful for this device, or is
         not settable.

@see HALData::TAttribute
@see HALData::TAttributeProperty

for individual attributes in TAttribute

API status: Required capability: WriteDeviceData or other capability specified

Parameters

aDeviceNumber	The device number. (eg: screen number)
aAttribute	The HAL attribute.
aValue	The attribute value.

(generated from Symbian Developer Library)

The documentation for this class was generated from the following files:

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ TEntryProperty

Member Function Documentation

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAll()

◆ Set() [1/2]

◆ Set() [2/2]