epoc32/include/e32const.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1994-2009 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 "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     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.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    18 #ifndef __E32CONST_H__
    18 #ifndef __E32CONST_H__
    19 #define __E32CONST_H__
    19 #define __E32CONST_H__
    20 
    20 
    21 #include <e32err.h>
    21 #include <e32err.h>
    22 #include <e32lang.h>
    22 #include <e32lang.h>
    23 
    23 #include <e32reg.h>
    24 
    24 
    25 
    25 
    26 /**
    26 /**
    27 @publishedAll
    27 @publishedAll
    28 @released
    28 @released
   521 @publishedAll
   521 @publishedAll
   522 @released
   522 @released
   523 
   523 
   524 A default stack size that can be used when creating threads.
   524 A default stack size that can be used when creating threads.
   525 */
   525 */
       
   526 #ifdef __X86GCC__
       
   527 const TInt KDefaultStackSize=0x4000;
       
   528 #else
   526 const TInt KDefaultStackSize=0x2000;
   529 const TInt KDefaultStackSize=0x2000;
       
   530 #endif // __X86GCC__
   527 
   531 
   528 
   532 
   529 
   533 
   530 
   534 
   531 /**
   535 /**
  1020 Defines the state of a battery, if supported.
  1024 Defines the state of a battery, if supported.
  1021 */
  1025 */
  1022 enum TBatteryState {EBatNotSupported,EBatGood,EBatLow};
  1026 enum TBatteryState {EBatNotSupported,EBatGood,EBatLow};
  1023 
  1027 
  1024 
  1028 
       
  1029 /**
       
  1030 @publishedAll
       
  1031 @released
       
  1032 
       
  1033 Defines the possible connection types used to interface to the media.
       
  1034 */
       
  1035 enum TConnectionBusType {EConnectionBusInternal, EConnectionBusUsb};
  1025 
  1036 
  1026 
  1037 
  1027 /**
  1038 /**
  1028 @publishedAll
  1039 @publishedAll
  1029 @released
  1040 @released
  1143 
  1154 
  1144 /**
  1155 /**
  1145 @publishedAll
  1156 @publishedAll
  1146 @released
  1157 @released
  1147 
  1158 
       
  1159 Drive attribute - drive is external.
       
  1160 */
       
  1161 const TUint KDriveAttExternal=0x800;
       
  1162 
       
  1163 
       
  1164 /**
       
  1165 @publishedAll
       
  1166 @released
       
  1167 
  1148 Drive attribute - It can be set in a search in order to instruct that all drives should be returned.
  1168 Drive attribute - It can be set in a search in order to instruct that all drives should be returned.
  1149 */
  1169 */
  1150 const TUint KDriveAttAll=0x100000;
  1170 const TUint KDriveAttAll=0x100000;
  1151 
       
  1152 
  1171 
  1153 
  1172 
  1154 /**
  1173 /**
  1155 @publishedAll
  1174 @publishedAll
  1156 @released
  1175 @released
  1169 Drive attribute - It can be set in combination with other drive attributes in order to search and return exclusively drives with these attributes set.
  1188 Drive attribute - It can be set in combination with other drive attributes in order to search and return exclusively drives with these attributes set.
  1170 */
  1189 */
  1171 const TUint KDriveAttExclusive=0x80000;
  1190 const TUint KDriveAttExclusive=0x80000;
  1172 
  1191 
  1173 
  1192 
       
  1193 
  1174 /**
  1194 /**
  1175 @internalTechnology
  1195 @internalTechnology
  1176 
  1196 
  1177 Used as a mask in order to extract the actual drive attributes.
  1197 Used as a mask in order to extract the actual drive attributes.
  1178 
  1198 
  1179 */
  1199 */
  1180 const TUint KDriveAttMatchedFlags=0xFFF;
  1200 const TUint KDriveAttMatchedFlags=0xFFF;
  1181 
  1201 
  1182 
  1202 
       
  1203 
  1183 /**
  1204 /**
  1184 @internalTechnology
  1205 @internalTechnology
  1185 
  1206 
  1186 Used as a mask in order to extract the extra(ex KDriveAttAll ,KDriveAttExclude, KDriveAttExclusive ,0) drive attributes.
  1207 Used as a mask in order to extract the extra(ex KDriveAttAll ,KDriveAttExclude, KDriveAttExclusive ,0) drive attributes.
  1187 */
  1208 */
  1188 const TUint KDriveAttMatchedAtt=0x0FFF0000;
  1209 const TUint KDriveAttMatchedAtt=0x0FFF0000;
       
  1210 
       
  1211 
  1189 
  1212 
  1190 
  1213 
  1191 /**
  1214 /**
  1192 @publishedAll
  1215 @publishedAll
  1193 @released
  1216 @released
  1662 	/** Universal time and offset from GMT is supplied by the mobile network
  1685 	/** Universal time and offset from GMT is supplied by the mobile network
  1663 	and maintained by device RTC */
  1686 	and maintained by device RTC */
  1664 	ENITZNetworkTimeSync
  1687 	ENITZNetworkTimeSync
  1665 	};
  1688 	};
  1666 
  1689 
       
  1690 /**
       
  1691 @internalComponent
       
  1692 
       
  1693 Indicates the type of conversion required for FAT filenames
       
  1694 */
       
  1695 enum TFatFilenameConversionType
       
  1696 	{
       
  1697 	/** Undefined conversion scheme; conversion obtained is whatever the
       
  1698 	default policy is for this version of the OS. */
       
  1699 	EFatConversionDefault = 0,
       
  1700 	/** x-fat<nnn>.dll is loaded, where <nnn> is the FAT filename conversion number. */
       
  1701 	EFatConversionNonStandard = 1,
       
  1702 	/** cp<nnn>.dll is loaded, where <nnn> is the FAT filename conversion number. */
       
  1703 	EFatConversionMicrosoftCodePage = 2
       
  1704 	};
  1667 
  1705 
  1668 
  1706 
  1669 /**
  1707 /**
  1670 @publishedAll
  1708 @publishedAll
  1671 @released
  1709 @released
  1819 	EPriorityAbsoluteRealTime5=850,
  1857 	EPriorityAbsoluteRealTime5=850,
  1820 	EPriorityAbsoluteRealTime6=860,
  1858 	EPriorityAbsoluteRealTime6=860,
  1821 	EPriorityAbsoluteRealTime7=870, 
  1859 	EPriorityAbsoluteRealTime7=870, 
  1822 	EPriorityAbsoluteRealTime8=880
  1860 	EPriorityAbsoluteRealTime8=880
  1823 	};
  1861 	};
  1824 
       
  1825 
       
  1826 
       
  1827 
       
  1828 /**
       
  1829 @publishedPartner
       
  1830 @interim
       
  1831 */
       
  1832 const TText KProtectedServerNamePrefix = '!';
       
  1833 
       
  1834 
  1862 
  1835 
  1863 
  1836 /**
  1864 /**
  1837 @publishedAll
  1865 @publishedAll
  1838 @released
  1866 @released
  2112 @publishedAll
  2140 @publishedAll
  2113 @released
  2141 @released
  2114 
  2142 
  2115 A bitmask for all flags except those with symbols starting KRealFormat...
  2143 A bitmask for all flags except those with symbols starting KRealFormat...
  2116 */
  2144 */
  2117 const TInt KRealFormatTypeFlagsMask=0x7C000000;
  2145 const TInt KRealFormatTypeFlagsMask=0x7E000000;
  2118 
  2146 
  2119 
  2147 
  2120 
  2148 
  2121 
  2149 
  2122 /**
  2150 /**
  2207 If not set, the precision defaults to KMaxPrecision digits.
  2235 If not set, the precision defaults to KMaxPrecision digits.
  2208 
  2236 
  2209 This flag should be ORed into TRealFormat::iType.
  2237 This flag should be ORed into TRealFormat::iType.
  2210 */
  2238 */
  2211 const TInt KGeneralLimit=0x04000000;
  2239 const TInt KGeneralLimit=0x04000000;
       
  2240 
       
  2241 
       
  2242 
       
  2243 
       
  2244 /**
       
  2245 @publishedAll
       
  2246 @released
       
  2247 
       
  2248 A flag that modifies the format of the character representation of a real
       
  2249 number.
       
  2250 
       
  2251 If set, this flag allows enough digits of precision such that the mapping from
       
  2252 numeric to string form is injective. For a TReal (=double) input argument
       
  2253 this means KIEEEDoubleInjectivePrecision digits.
       
  2254 This flag overrides the KGeneralLimit flag if both are set.
       
  2255 
       
  2256 This flag should be ORed into TRealFormat::iType.
       
  2257 */
       
  2258 const TInt KRealInjectiveLimit=0x02000000;
  2212 
  2259 
  2213 
  2260 
  2214 
  2261 
  2215 
  2262 
  2216 /**
  2263 /**
  2361 	EChangesSystemTime=0x10,
  2408 	EChangesSystemTime=0x10,
  2362 	
  2409 	
  2363 
  2410 
  2364 	/**
  2411 	/**
  2365 	The free memory level has crossed a specified threshold value.
  2412 	The free memory level has crossed a specified threshold value.
       
  2413 	
       
  2414 	On systems that support data paging, this is also generated where the available swap space
       
  2415 	crosses one of the specified threshold values.
  2366 	*/
  2416 	*/
  2367 	EChangesFreeMemory=0x20,
  2417 	EChangesFreeMemory=0x20,
  2368 
  2418 
  2369 	
  2419 	
  2370 	/**
  2420 	/**
  2376 	/**
  2426 	/**
  2377 	The free memory level has fallen below the low-memory threshold
  2427 	The free memory level has fallen below the low-memory threshold
  2378 	@see UserSvr::SetMemoryThresholds()
  2428 	@see UserSvr::SetMemoryThresholds()
  2379 	*/
  2429 	*/
  2380 	EChangesLowMemory=0x80,
  2430 	EChangesLowMemory=0x80,
       
  2431 
       
  2432 	/**
       
  2433 	On systems that support data paging, this is generated where the thrashing level crosses one of
       
  2434 	the specified threshold values.
       
  2435 	*/
       
  2436 	EChangesThrashLevel=0x100,
       
  2437 
       
  2438 	/**********************************************************************************
       
  2439 	**  IF YOU ADD A NEW VALUE HERE, YOU NEED TO UPDATE DChangeNotifier CONSTRUCTOR  **
       
  2440 	**********************************************************************************/
  2381 	};
  2441 	};
  2382 
  2442 
  2383 
  2443 
  2384 
  2444 
  2385 
  2445 
  2995 
  3055 
  2996 Client/Server Session types.
  3056 Client/Server Session types.
  2997 */
  3057 */
  2998 enum TIpcSessionType
  3058 enum TIpcSessionType
  2999 	{
  3059 	{
  3000 	/**
  3060 	// These values are used at session creation time to describe the extent to which
  3001 	The session is not sharable with other threads.
  3061 	// the new session may be shared.
  3002 	*/
  3062 	//
  3003 	EIpcSession_Unsharable=0,
  3063 	// They are *also* used at server creation time, to specify the *maximum* degree
  3004 
  3064 	// of session sharability that the server supports. Thus, if a server instance was
  3005 	/**
  3065 	// created with mode EIpcSession_Sharable, you can open Sharable or Unsharable
  3006 	The session is sharable with other threads in the same process.
  3066 	// sessions with it, but not globally sharable ones.
  3007 	*/
  3067 	EIpcSession_Unsharable					= 0x00000000,
  3008 	EIpcSession_Sharable=1,
  3068 	EIpcSession_Sharable					= 0x00000001,	// sharable within one process
  3009 
  3069 	EIpcSession_GlobalSharable				= 0x00000002	// sharable across processes
  3010 	/**
       
  3011 	The session is sharable with all other threads in the system.
       
  3012 	*/
       
  3013 	EIpcSession_GlobalSharable=2
       
  3014 	};
  3070 	};
  3015 
  3071 
       
  3072 enum TIpcServerRole
       
  3073 	{
       
  3074 	EServerRole_Default = 0,								// No role specified; treated as Standalone
       
  3075 	EServerRole_Standalone,									// Explicitly neither Master nor Slave
       
  3076 	EServerRole_Master,										// Master: may transfer sessions to a Slave
       
  3077 	EServerRole_Slave										// Slave: accepts sessions from the Master
       
  3078 	};
       
  3079 
       
  3080 enum TIpcServerOpts
       
  3081 	{
       
  3082 	// The first few bits specify whether memory referred to by descriptors
       
  3083 	// passed from the client to the server should automatically be pinned
       
  3084 	// All other bits are reserved for future expansion ...
       
  3085 	EServerOpt_PinClientDescriptorsDefault	= 0x00000000,	/**<@internalComponent*/
       
  3086 	EServerOpt_PinClientDescriptorsEnable 	= 0x00000004,	/**<@internalComponent*/
       
  3087 	EServerOpt_PinClientDescriptorsDisable	= 0x00000008,	/**<@internalComponent*/
       
  3088 	EServerOpt_PinClientDescriptorsMask		= 0x0000000c	/**<@internalComponent*/
       
  3089 	};
       
  3090 
  3016 
  3091 
  3017 
  3092 
  3018 
  3093 
  3019 /**
  3094 /**
  3020 @publishedAll
  3095 @publishedAll
  3021 @released
  3096 @released
  3022 */
  3097 */
  3023 const TInt KNullDebugPort=-2;
  3098 const TInt KNullDebugPort=-2;
  3024 
       
  3025 /**
       
  3026 @internalTechnology
       
  3027 */
       
  3028 const TUint32 KModuleVersionWild=0xfffffffeu;
       
  3029 /**
       
  3030 @internalTechnology
       
  3031 */
       
  3032 const TUint32 KModuleVersionNull=0xffffffffu;
       
  3033 
       
  3034 
  3099 
  3035 
  3100 
  3036 /**
  3101 /**
  3037 A constant which represents a thread ID which will never be assigned to a thread.
  3102 A constant which represents a thread ID which will never be assigned to a thread.
  3038 I.e. The following statement is always true; RThread::Id()!=KNullThreadId
  3103 I.e. The following statement is always true; RThread::Id()!=KNullThreadId
  3066 	/** No hardware floating point. */
  3131 	/** No hardware floating point. */
  3067 	EFpTypeNone=0,
  3132 	EFpTypeNone=0,
  3068 	/** ARM VFPv2 */
  3133 	/** ARM VFPv2 */
  3069 	EFpTypeVFPv2=1,
  3134 	EFpTypeVFPv2=1,
  3070 	/** ARM VFPv3 */
  3135 	/** ARM VFPv3 */
  3071 	EFpTypeVFPv3=2
  3136 	EFpTypeVFPv3=2,
       
  3137 	/** ARM VFPv3-D16 (VFP only, no NEON) */
       
  3138 	EFpTypeVFPv3D16=3,
  3072 	};
  3139 	};
  3073 
  3140 
  3074 
  3141 
  3075 
  3142 
  3076 /**
  3143 /**
  3135 
  3202 
  3136 
  3203 
  3137 
  3204 
  3138 #include <e32capability.h>
  3205 #include <e32capability.h>
  3139 
  3206 
       
  3207 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
  3208 #include <e32const_private.h>
  3140 #endif
  3209 #endif
       
  3210 
       
  3211 #endif