![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
|
|
|
|
|
|
||
__Align (s) ((((s)+__Size-1)/__Size)*__Size)
Aligns the specified value on the boundary defined by __Size. This is usually 4 for byte alignment or 2 for double-byte alignment.
|
typedef TInt(* TThreadFunction)(TAny*);
Defines a pointer to a thread function which takes a pointer of type TAny and returns a TInt.
A function of this type is passed as parameter to RThread::Create(const TDesC &,TThreadFunction,TInt,TInt,TInt,TAny *,TOwnerType) when creating a thread. Control passes to this function when the thread is first scheduled for execution.
typedef TInt(* TLibraryFunction)();
Defines a function that takes no arguments but returns a TInt.
This is a type which is returned from a call to RLibrary::Lookup(TInt)const.
typedef TInt(* TLibraryEntry)(TInt);
Defines a function that takes a single argument of type TInt and returns a TInt.
This is a type which is returned from a call to RLibrary::EntryPoint().
typedef void(* TExceptionHandler)(TExcType);
Defines an exception handler function which takes a TExcType as an argument, and returns void.
A function of this type is an exception handler used by member functions of a thread handle, RThreadRThread.
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
RThreadRThreadA handle to a thread.TExcTypeTExcTypeA list of exception types which a thread's exception handler might deal with. An...TMediaType
Defines the possible media types.
|
TBatteryState
Defines the state of a battery, if supported.
|
TFalse
An enumerator with a single enumeration value that defines the Boolean value false in Symbian OS.
|
TTrue
An enumerator with a single enumeration value that defines the Boolean value true in Symbian OS.
|
TAllowDuplicates
Defines flags that can be used to indicate whether duplicates, for example in a list, are allowed.
|
TRadix
An enumeration whose enumerators determine the number system to be used when converting numbers into a character format.
TDes8::Num(TInt64)Converts the 64-bit signed integer into a decimal character representation and c...TDes8::NumUC(TUint64,TRadix)Converts the specified 64-bit unsigned integer into a character representation b...TDes8::AppendNum(TInt64)Converts the 64-bit signed integer into a decimal character representation and a...TDes8::AppendNumUC(TUint64,TRadix)Converts the specified 64-bit unsigned integer into a character representation b...TDes16::Num(TReal,const TRealFormat &)Converts the specified floating point number into a character representation and...TDes16::NumUC(TUint64,TRadix)Converts the specified 64 bit unsigned integer into a character representation b...TDes16::AppendNum(TReal,const TRealFormat &)Converts the specified floating point number into a character representation and...TDes16::AppendNumUC(TUint64,TRadix)Converts the specified 64 bit integer into a character representation based on t...
|
TDateFormat
Defines the date formats.
|
TClockFormat
Defines the clock display formats, as either analog or digital.
|
TUnitsFormat
Enumerates the units of measurement as either Imperial or Metric.
|
TLocalePos
Defines whether:
1. the currency symbol is located before or after the currency amount.
2. the am/pm text is located before or after the time.
|
TDigitType
Number Modes available to select.
TDaylightSavingZone
Defines the daylight saving zones.
|
TDay
Defines the days of the week.
The enumerator symbol names correspond with the days of the week, i.e. EMonday refers to Monday etc.
|
TMonth
Defines the months of the year.
The enumerator symbol names correspond with the months of the year, i.e. EJanuary refers to January etc.
|
TOwnerType
Handle ownership flags.
The flags indicate whether a handle being opened is owned by a process or a thread.
Ownership by a process means that the handle instance can be used by all threads in the process to access the Kernel side object that the handle represents.
Ownership by a thread means that the handle instance can only be used by the thread that creates or opens the handle.
An enumerator of this type is passed to all member functions of RHandleBaseRHandleBase, and classes derived from RHandleBaseRHandleBase, which open a handle.
|
TProcessPriority
Defines process priorities.
The enumerator values are passed to RProcess::SetPriority(TProcessPriority)const.
The priorities are listed in relative order stating with the lowest.
|
TThreadPriority
Defines thread priorities.
The enumerator values are passed to RThread::SetPriority(TThreadPriority)const.
The relative priorities are listed in order starting with the lowest.
The absolute thread priorities are listed in order starting with the lowest.
|
TExcType
A list of exception types which a thread's exception handler might deal with. An enumerator of this type is passed to User::IsExceptionHandled(TExcType) and User::RaiseException(TExcType).
While an exception handler can deal with exceptions as listed in the exception constants set, a TExcType is simply a type of exception. For example, EExcIntegerDivideByZero and EExcIntegerOverflow are types of KExceptionInteger exception.
|
TExitType
Identifies how a thread or process has ended.
While a thread or process is alive, its exit type is always EExitPending.
Both RThread::ExitType()const and RProcess::ExitType()const return a TExitType.
RThread::ExitType()constTests whether the thread has ended and, if it has ended, return how it ended.RProcess::ExitType()constTests whether the process has ended and, if it has ended, return how it ended.User::Exit(TInt)Terminates the current thread, specifying a reason. All child threads are termin...RThread::Kill(TInt)Ends the thread, specifying a reason code.RProcess::Kill(TInt)Ends this process, and all of its threads, specifying a reason code.
|
TAlign
An enumeration whose enumerators govern the alignment of data which is copied or formatted into a descriptor.
TDes8::Justify(const TDesC8 &,TInt,TAlign,TChar)Copies data into this descriptor and justifies it, replacing any existing data.TDes8::AppendJustify(const TDesC8 &,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.TDes16::Justify(const TDesC16 &,TInt,TAlign,TChar)Copies data into this descriptor and justifies it, replacing any existing data.TDes16::AppendJustify(const TDesC16 &,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.
|
TLeave
A value, which when passed to the new operator, indicates that the operation is to leave if insufficient memory available.
|
TFirstWeekRule
Defines the way in which the first week in a year is determined.
|
TTimerLockSpec
Timer lock specifications.
They are used by CTimer::Lock(TTimerLockSpec) to define the fraction of a second in which to call its RunL() function.
|
TChanges
Defines the possible environment changes which may be reported by a change notifier through the RChangeNotifierRChangeNotifier interface.
Each enumerator corresponds to a distinct type of event.
The changes are reported through a TRequestStatusTRequestStatus object when a request to the change notifier completes. As each enumerator value represents a separate bit, any combination
of events can be reported.
RChangeNotifierRChangeNotifierA handle to a change notifier.
|
TProcessParameterType
Defines the type of environment data passed to a process when that process is created.
The data can be either a handle or just binary data.
|
TIpcSessionType
Client/Server Session types.
|
TFloatingPointType
Hardware floating point types.
|
TFloatingPointMode
Hardware floating point execution modes.
|
TFloatingPointRoundingMode
Hardware floating point rounding modes.
|
const TInt KDefaultJustifyWidth=(-1);
The default width value used when appending and justifying data in a descriptor.
TDes16::AppendJustify(const TDesC16 &,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.TDes16::Justify(const TDesC16 &,TInt,TAlign,TChar)Copies data into this descriptor and justifies it, replacing any existing data.TDes8::AppendJustify(const TDesC8 &,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.TDes8::Justify(const TDesC8 &,TInt,TAlign,TChar)Copies data into this descriptor and justifies it, replacing any existing data.const TInt KMaxCheckedUid=3;
Defines the number of TUids that form a TUidTypeTUidType.
const TInt KMaxUidName=10;
Defines the maximum length for the text form of a UID name.
TUidNameTUidName...TUid::Name()constGenerates and returns the standard text form of the UID.const TInt KMaxName=0x80;
Defines the maximum length of the name of a reference counted object.
const TInt KMaxKernelName=0x50;
Defines the maximum length of the name of a reference counted kernel-side object.
const TInt KMaxProcessName=(KMaxKernelName-KMaxUidName-KMaxModuleVersionName-4);
Defines the maximum size of a process name.
const TInt KMaxLibraryName=(KMaxKernelName-KMaxUidName-KMaxModuleVersionName);
Defines the maximum size of a library name.
const TInt KMaxFullName=(KMaxName<<1);
Defines the maximum length of the full name of a reference counted object.
const TInt KMaxDayName=0x20;
The maximum length of the full text name for a day of the week.
const TInt KMaxDayNameAbb=0x08;
The maximum length of the abbreviated text name for a day of the week.
const TInt KMaxDays=7;
Defines the maximum size of arrays or data structures required to hold the names of the days of the week.
const TInt KMaxMonthNameAbb=0x08;
The maximum length of the abbreviated text name for a month.
const TInt KMaxMonths=12;
Defines the maximum size of arrays or data structures required to hold the names of the months of the year.
const TInt KMaxSuffixes=31;
Defines the maximum size of arrays and data structures required to hold date suffix strings.
const TInt KMaxAmPms=2;
Defines the maximum size of arrays and data structures required to hold am/pm strings.
const TInt KMaxDateSeparators=4;
Defines the maximum number of date separator characters in a date string.
const TInt KMaxTimeSeparators=4;
Defines the maximum number of time separator characters in a time string.
const TInt KMaxTranslateTable=0x100;
Defines the maximum size of data structures to hold the translate tables for Western European alphabetic conversions.
const TInt KMaxCurrencySymbol=0x08;
The maximum length of the text for a currency symbol.
const TInt KMaxShortDateFormatSpec=40;
The maximum length of the short date format specification text.
const TInt KMaxLongDateFormatSpec=80;
The maximum length of the short date format specification text.
const TInt KMaxTimeFormatSpec=60;
The maximum length of the time string formatting commands.
const TInt KMaxVersionName=0x10;
The maximum length of the character representation of version information.
TVersion::Name()constGets a descriptor buffer containing the formatted character representation of th...const TInt KMaxMediaPassword=16;
The maximum size of the password required to unlock a media drive.
const TInt KMinHeapSize=0x100;
Defines the minimum size of a new heap.
Functions that require a new heap to be allocated will either panic, or will reset the required heap size to this value if a smaller heap size is specified.
UserHeapUserHeapA set of static functions for constructing fixed length heaps and local or globa...RThread::Create(const TDesC &,TThreadFunction,TInt,TInt,TInt,TAny *,TOwnerType)Creates a thread belonging to the current process, and opens this handle to that...const TInt KDefaultStackSize=0x2000;
A default stack size that can be used when creating threads.
const TUint KNoChar=0xffffffffu;
Indicates an undefined character, used internally when formatting text.
const TInt KIndexPtr=(-1);
Defines an index value that is interpreted by the TKeyTKey class, and derived classes, as having a specific meaning.
TKey::SetPtr(const TAny *)Sets the pointer to a sample element whose key is to be used for comparison.TKey::At(TInt)constGets a pointer to the key of a specified array element.const TInt KHandleNoClose=0x00008000;
A flag used by the kernel to mark a handle as not being closable.
const TInt KHandleFlagLocal=0x40000000;
A flag used by the kernel to mark a handle as being local.
const TInt KCurrentProcessHandle=0xffff0000|KHandleNoClose;
A flag used by the Kernel to indicate the current process.
const TInt KCurrentThreadHandle=0xffff0001|KHandleNoClose;
A flag used by the Kernel to indicate the current thread.
const TInt KNullHandle=0;
Defines a handle number value of zero.
RHandleBaseRHandleBaseA handle to an object.const TInt KNullUnit=0xffffffff;
The device unit that must be passed in a call to RBusLogicalChannel::DoCreate(const TDesC &,const TVersion &,TInt,const TDesC *,const TDesC8 *,TOwnerType,TBool), if units are not permitted.
const TInt KMaxUnits=0x20;
The maximum unit number that can be passed in a call to RBusLogicalChannel::DoCreate(const TDesC &,const TVersion &,TInt,const TDesC *,const TDesC8 *,TOwnerType,TBool).
const TInt KMaxMessageArguments=0x04;
Defines the maximum number of message arguments that can be passed across the user side/kernel side boundary.
const TInt KDefaultRealWidth=20;
The default width of the character representation of a real number, used by the default constructor of a TRealFormatTRealFormat object and the formatting functions of descriptors.
TRealFormatTRealFormat...TDes16::AppendFormat(TRefByValue< const TDesC16 >,TDes16Overflow *,...)Formats and appends text onto the end of this descriptor's data.TDes8::AppendFormat(TRefByValue< const TDesC8 >,TDes8Overflow *,...)Formats and appends text onto the end of this descriptor's data.const TInt KMinHeapGrowBy=0x1000;
The default value used by UserHeap::ChunkHeap(const TDesC *,TInt,TInt,TInt,TInt,TBool) for defining increments to the size of a chunk, when no explicit value specified by the caller.
UserHeap::ChunkHeap(const TDesC *,TInt,TInt,TInt,TInt,TBool)Creates a heap in a local or global chunk.| Interface status: | deprecated |
const TInt KDeltaTimerDefaultGranularity=100000;
The timer granularity used by a CDeltaTimerCDeltaTimer object is now the tick period and this constant is obsolete.
CDeltaTimerCDeltaTimerA queue of timed events.const TInt64 KMaxTInt64=I64LIT(0x7fffffffffffffff);
The largest possible value for a TInt64.
const TInt64 KMinTInt64=UI64LIT(0x8000000000000000);
The smallest possible value for a TInt64.
const TUint64 KMaxTUint64=UI64LIT(0xffffffffffffffff);
The largest possible value for a TUint64.
const TUint KMatchAny='*';
Defines the character *, and represents any number of characters in any part of a path component, filename or extension.
It is used in a TParse file specification.
const TUint KMatchOne='?';
Defines the character ?, and represents a single character in a path component, filename or extension.
It is used in a TParse file specification.
const TInt KRequestPending=(-KMaxTInt);
The value to which CActive::iStatus is set by an active object's service provider before the service provider initiates an asynchronous request.
const TUint KDriveAttRedirected=0x04;
Drive attribute - output from a process on one drive is redirected to another drive.
const TUint KDriveAttSubsted=0x08;
Drive attribute - drive letter has been substituted (assigned a path).
const TUint KDriveAttInternal=0x10;
Drive attribute - drive is internal (not removable).
const TUint KDriveAttLogicallyRemovable=0x200;
Drive attribute - drive is logically removable (can be taken offline from Symbian OS). If not logically removable then physically removable e.g. a card can be take out.
const TUint KDriveAttHidden=0x400;
Drive attribute - drive is hidden. A drive which has its hidden attribute set would be excluded from the list of available drives.
const TUint KDriveAttAll=0x100000;
Drive attribute - It can be set in a search in order to instruct that all drives should be returned.
const TUint KDriveAttExclude=0x40000;
Drive attribute - It can be set in combination with other drive attributes in order to exclude during a drive search, drives with these attributes set.
const TUint KDriveAttExclusive=0x80000;
Drive attribute - It can be set in combination with other drive attributes in order to search and return exclusively drives with these attributes set.
const TUint KMediaAttVariableSize=0x01;
Media attribute - the media capacity can change over time.
const TUint KMediaAttLockable=0x10;
Media attribute - media is lockable; this is provided for lockable multi-media cards
const TUint KMediaAttLocked=0x20;
Media attribute - media is locked; this is provided for lockable multi-media cards
const TUint KMediaAttDeleteNotify=0x100;
Media attribute - media supports TBusLocalDrive::DeleteNotify(TInt64,TInt)
const TUint KDriveFileNone=0x05;
Identifies a non-file system. That is a partition without any file system layer.
const TInt KRealFormatTypesMask=0x00000007;
A mask for the set of flags that govern the general format of the character representation of a real number.
These are the flags with symbols starting KRealFormat...
const TInt KRealFormatFixed=1;
Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.
The real number is converted to fixed format which has the general pattern: "nnn.ddd", where nnn is the integer portion and ddd is the decimal portion. A negative value is prefixed by a minus sign.
The number of decimal places generated is defined by the value of TRealFormat::iPlaces. Trailing zeroes are generated as required. If necessary, the decimal portion is rounded to fit the specification. If this
value is zero, no decimal point and no decimal portion is generated.
Triad separation is available, defined by TRealFormat::iTriad and TRealFormat::iTriLen.
Note that a zero value is converted either to the form "0.000..." with iPlaces '0' characters after the decimal point, if iPlaces is greater than zero, or to "0" if iPlaces is zero.
const TInt KRealFormatExponent=2;
Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.
The real number is converted to scientific format with one non-zero digit before the decimal point and a number of digits after the decimal point. Hence the number has the general pattern: "n.dddE+ee" or "n.dddE-ee", or "n.dddE+eee" or "n.dddE-eee".
The decimal portion is followed by the character 'E', a sign ('+' or '-') and the exponent as two digits, including leading zeroes, if necessary. If necessary, the decimal portion is rounded.
A negative value is prefixed by a minus sign.
If the flag KUseSigFigs is not set, TRealFormat::iPlaces defines the number of digits which follow the decimal point. If the flag KUseSigFigs is set, iPlaces defines the maximum
number of significant digits to be generated.
Note that, by default, exponents are limited to two digits. Those numbers that require three digits must have the flag KAllowThreeDigitExp set. If iPlaces is zero, the value is rounded to one digit of precision and no decimal point is included.
Triad separation is not available.
Note that a zero value is converted either to the form "0.000...E+00" with iPlaces '0' characters after the decimal point, if iPlaces is greater than zero, or to "0E+00" if iPlaces is zero.
const TInt KRealFormatGeneral=3;
Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.
The real number is converted either to fixed or scientific format. The format chosen is the one which can present the greater number of significant digits. Where both formats can present the same number of significant digits, fixed format is used.
The number of decimal places generated depends only on the value of TRealFormat::iWidth; the value of the iPlaces member is ignored.
Trailing zeroes in the decimal portion are discarded.
Triad separation is not available.
Note that a zero value is converted to "0".
const TInt KRealFormatNoExponent=4;
Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.
The same as KRealFormatFixed but the TRealFormat::iPlaces is interpreted as specifying the maximum number of significant digits.
Trailing zeroes in the decimal portion are discarded.
const TInt KRealFormatCalculator=5;
Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.
The same as KRealFormatGeneral but TRealFormat::iPlaces is interpreted as specifying the maximum number of significant digits, and the number is displayed without an exponent whenever
possible.
Trailing zeroes in the decimal portion are discarded.
const TInt KRealFormatTypeFlagsMask=0x7C000000;
A bitmask for all flags except those with symbols starting KRealFormat...
const TInt KExtraSpaceForSign=0x40000000;
A flag that modifies the format of the character representation of a real number.
It reduces the effective width by one character. This forces a large enough value for TRealFormat::iWidth to be chosen to guarantee that positive and negative numbers can be shown to the same precision.
It applies when TRealFormat::iType is set to KRealFormatFixed or KRealFormatGeneral, and should be ORed into TRealFormat::iType after one of these types has been set.
const TInt KAllowThreeDigitExp=0x20000000;
A flag that modifies the format of the character representation of a real number.
It allows an exponent to be formatted whose magnitude is greater than 100. If this flag is not set, an attempt to format such a number fails.
If set, three digit exponents are allowed. If not set, only two digit exponents are allowed.
Applies when TRealFormat::iType is set to KRealFormatExponent or KRealFormatGeneral, and should be ORed into TRealFormat::iType after one of these types has been set.
const TInt KUseSigFigs=0x10000000;
A flag that modifies the format of the character representation of a real number.
If set, the TRealFormat::iPlaces member is interpreted as the maximum number of significant digits to be generated.
Applies when TRealFormat::iType is set to KRealFormatExponent, and should be ORed into TRealFormat::iType after this type has been set.
const TInt KDoNotUseTriads=0x08000000;
A flag that modifies the format of the character representation of a real number.
It disables triad separation.
Applies when TRealFormat::iType is set to KRealFormatFixed or KRealFormatNoExponent, and should be ORed into TRealFormat::iType after one of these types has been set.
const TInt KGeneralLimit=0x04000000;
A flag that modifies the format of the character representation of a real number.
If set, this flag limits the precision to KPrecisionLimit digits. If not set, the precision defaults to KMaxPrecision digits.
This flag should be ORed into TRealFormat::iType.
const TUint KExceptionAbort=0x01;
One of a set of flags that categorizes exceptions - associated with the abort exception only.
const TUint KExceptionKill=0x02;
One of a set of flags that categorizes exceptions - associated with the kill exception only.
const TUint KExceptionUserInterrupt=0x04;
One of a set of flags that categorizes exceptions - general and user exceptions.
const TUint KExceptionFpe=0x08;
One of a set of flags that categorizes exceptions - exceptions caused by illegal floating point operations. This exception is not guaranteed to be raised when a hardware floating point implementation is in use.
const TUint KExceptionFault=0x10;
One of a set of flags that categorizes exceptions - exceptions associated with executing instructions; includes protection faults, illegal instruction codes, page faults etc
const TUint KExceptionInteger=0x20;
One of a set of flags that categorizes exceptions - exceptions caused by illegal operations on integer values.
const TUint KExceptionDebug=0x40;
One of a set of flags that categorizes exceptions - exceptions raised when debugging code.
const TUint32 KSet32=0xffffffff;
Constant that defines the specified bit value.
This is often used as a bit mask.
const TUint32 KClear32=0x00000000;
Constant that defines the specified bit value.
This is often used as a bit mask.
const TUint KNullThreadId=0xffffffffu;
A constant which represents a thread ID which will never be assigned to a thread. I.e. The following statement is always true;
RThread::Id()const!=KNullThreadId
const TUint KNullProcessId=0xffffffffu;
A constant which represents a process ID which will never be assigned to a process. I.e. The following statement is always
true; RProcess::Id()const!=KNullProcessId
|
Copyright © 2005-2008 Symbian Software Ltd. |
|
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)