halservices/hal/inc/hal.h
branchRCL_3
changeset 28 5b5d147c7838
parent 0 a41df078684a
equal deleted inserted replaced
26:c734af59ce98 28:5b5d147c7838
     1 // Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1995-2010 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Eclipse Public License v1.0"
     4 // under the terms of the License "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
   122 
   122 
   123     /**
   123     /**
   124     Gets all HAL attributes, and their properties.
   124     Gets all HAL attributes, and their properties.
   125 
   125 
   126     For attributes that are not meaningful on this device (ie. those which have
   126     For attributes that are not meaningful on this device (ie. those which have
   127 	not been defined in the config.hcf file),
   127 	not been defined in the config.hcf file), the attribute value and its 
   128 	the attribute value and its associated property value are set to zero in
   128 	associated property value are set to zero in the returned array.
   129 	the returned array.
       
   130 
   129 
   131 	Attributes for which multiple values can be retrieved
   130 	Attributes for which multiple values can be retrieved
   132 	ie. EDisplayIsPalettized, EDisplayBitsPerPixel, EDisplayOffsetToFirstPixel,
   131 	ie. EDisplayIsPalettized, EDisplayBitsPerPixel, EDisplayOffsetToFirstPixel,
   133 	EDisplayOffsetBetweenLines, and EDisplayPaletteEntry will also be zero in
   132 	EDisplayOffsetBetweenLines, and EDisplayPaletteEntry will also be zero in
   134 	the returned array.
   133 	the returned array.
       
   134 	
       
   135 	Attributes that allocate resources and open handles are also not returned 
       
   136 	by this API. Their value and property values will be set to zero in the
       
   137 	returned array. Use HAL::Get() for these attributes.
   135 
   138 
   136     @param aNumEntries On successful return, contains the total number
   139     @param aNumEntries On successful return, contains the total number
   137                        of HAL attributes.
   140                        of HAL attributes.
   138                        If the function returns KErrNoMemory, this value is set
   141                        If the function returns KErrNoMemory, this value is set
   139                        to zero.
   142                        to zero.