e32cmn.h File Reference

memcompare ( const TUint8 *, TInt, const TUint8 *, TInt )

IMPORT_C TIntmemcompare(const TUint8 *aLeft,
TIntaLeftLen,
const TUint8 *aRight,
TIntaRightLen
)

A Nanokernel utility function that compares two memory buffers for equality.

The two buffers are considered equal only if:

1. the buffers have the same length

and

2. the binary content of both buffers is the same.

Parameters
aLeftThe start address of the first buffer in the comparison.
aLeftLenThe length of the first buffer in the comparison.
aRightThe start address of the second buffer in the comparison.
aRightLenThe length of the second buffer in the comparison.
Return Value
Zero if both buffers are equal; non-zero, otherwise.
Panic Codes
USER88 In debug mode only, if aLeftL is negative, and the function is called on the user side.
KERN-COMMON88 In debug mode only, if aLeftL is negative, and the function is called on the kernel side.
USER89 In debug mode only, if aRightL is negative, and the function is called on the user side.
KERN-COMMON89 In debug mode only, if aRightL is negative, and the function is called on the kernel side.

wordmove ( TAny *, const TAny *, unsigned int )

IMPORT_C TAny *wordmove(TAny *aTrg,
const TAny *aSrc,
unsigned intaLength
)

A Nanokernel utility function that moves (copies) bytes in memory.

The function assumes that the addresses are aligned on word boundaries, and that the length value is a multiple of 4.

Parameters
aTrgThe target address.
aSrcThe source address.
aLengthThe number of bytes to be moved.
Return Value
The target address.
Panic Codes
USER91 In debug mode only, if aLength is not a multiple of 4, and the function is called on the user side.
KERN-COMMON91 In debug mode only, if aLength is not a multiple of 4, and the function is called on the kernel side.
USER92 In debug mode only, if aSrc is not aligned on a word boundary, and the function is called on the user side.
KERN-COMMON92 In debug mode only, if aSrc is not aligned on a word boundary, and the function is called on the kernel side.
USER93 In debug mode only, if aTrg is not aligned on a word boundary, and the function is called on the user side.
KERN-COMMON93 In debug mode only, if aTrg is not aligned on a word boundary, and the function is called on the kernel side.

memclr ( TAny *, unsigned int )

IMPORT_C TAny *memclr(TAny *aTrg,
unsigned intaLength
)

A Nanokernel utility function that sets the specified number of bytes to binary zero.

Parameters
aTrgThe start address.
aLengthThe number of bytes to be set.
Return Value
The target address.

memset ( TAny *, TInt, unsigned int )

IMPORT_C TAny *memset(TAny *aTrg,
TIntaValue,
unsigned intaLength
)

A Nanokernel utility function that sets all of the specified number of bytes to the specified fill value.

Parameters
aTrgThe start address.
aValueThe fill value (the first or junior byte).
aLengthThe number of bytes to be set.
Return Value
The target address.

memcpy ( TAny *, const TAny *, unsigned int )

IMPORT_C TAny *memcpy(TAny *aTrg,
const TAny *aSrc,
unsigned intaLength
)

A Nanokernel utility function that copies bytes in memory.

Parameters
aTrgThe target address.
aSrcThe source address.
aLengthThe number of bytes to be moved.
Return Value
The target address.

memmove ( TAny *, const TAny *, unsigned int )

IMPORT_C TAny *memmove(TAny *aTrg,
const TAny *aSrc,
unsigned intaLength
)

A Nanokernel utility function that moves (copies) bytes in memory.

Parameters
aTrgThe target address.
aSrcThe source address.
aLengthThe number of bytes to be moved.
Return Value
The target address.

Lim ( TInt, TUint )

TInt Lim(TIntaVal,
TUintaLimit
)[inline]

Tests whether the specified value is less than or equal to the specified upper limit.

Parameters
aValThe value to be tested.
aLimitThe upper limit.
Return Value
True, if the value is less than or equal to the specified upper limit; false, otherwise.

LimX ( TInt, TUint )

TInt LimX(TIntaVal,
TUintaLimit
)[inline]

Tests whether the specified value is strictly less than the specified upper limit.

Parameters
aValThe value to be tested.
aLimitThe upper limit.
Return Value
True, if the value is strictly less than the specified upper limit; false, otherwise.

Min ( T, T )

TMin(TaLeft,
TaRight
)[inline]

Returns the smaller of two values.

Parameters
aLeftThe first value to be compared.
aRightThe second value to be compared.
Return Value
The smaller value.

Min ( T, TUint )

TMin(TaLeft,
TUintaRight
)[inline]

Returns the smaller of two objects, where the right hand object is a treated as a TInt for the purpose of comparison.

Parameters
aLeftThe first value to be compared.
aRightThe second value to be compared.
Return Value
The smaller value.

Max ( T, T )

TMax(TaLeft,
TaRight
)[inline]

Returns the larger of two values.

Parameters
aLeftThe first value to be compared.
aRightThe second value to be compared.
Return Value
The larger value.

Max ( T, TUint )

TMax(TaLeft,
TUintaRight
)[inline]

Returns the larger of two objects, where the right hand object is a treated as a TInt for the purpose of comparison.

Parameters
aLeftThe first value to be compared.
aRightThe second value to be compared.
Return Value
The larger value.

Abs ( T )

TAbs(TaVal)[inline]

Returns an absolute value.

Parameters
aValThe source value.
Return Value
The absolute value

Rng ( T, T, T )

TBool Rng(TaMin,
TaVal,
TaMax
)[inline]

Determines whether a specified value lies within a defined range of values.

Parameters
aMinThe lower value of the range.
aValThe value to be compared.
aMaxThe higher value of the range.
Return Value
True, if the specified value lies within the range; false, otherwise.

PtrAdd ( T *, S )

T *PtrAdd(T *aPtr,
SaVal
)[inline]

Adds a value to a pointer.

Parameters
aPtrPointer to an object of type T.
aValThe value to be added.
Return Value
The resulting pointer value, as a pointer to a type T.

PtrSub ( T *, S )

T *PtrSub(T *aPtr,
SaVal
)[inline]

Subtracts a value from a pointer.

Parameters
aPtrPointer to an object of type T.
aValThe value to be added.
Return Value
The resulting pointer value, as a pointer to a type T.

Align2 ( T )

TAlign2(TaValue)[inline]

Aligns the specified value onto a 2-byte boundary.

Parameters
aValueThe value to be aligned.
Return Value
The aligned value.

Align4 ( T )

TAlign4(TaValue)[inline]

Aligns the specified value onto a 4-byte boundary.

Parameters
aValueThe value to be aligned.
Return Value
The aligned value.

__Size

Typedef TDesC

typedef TDesC16 TDesC

Defines a build-independent non-modifiable descriptor.

A 16-bit build variant is generated for a Unicode, non-kernel mode build.

A build-independent type should always be used unless an explicit 8-bit or 16-bit type is required.

See also: TDesC8 TDesC16

Typedef TPtrC

typedef TPtrC16 TPtrC

Defines a build-independent non-modifiable pointer descriptor.

A 16-bit build variant is generated for a Unicode, non-kernel mode build.

A build-independent type should always be used unless an explicit 8-bit or 16-bit type is required.

See also: TPtrC8 TPtrC16

Typedef TDes

typedef TDes16 TDes

Defines a build-independent modifiable descriptor.

A 16-bit build variant is generated for a Unicode, non-kernel mode build.

A build-independent type should always be used unless an explicit 8-bit or 16-bit type is required.

See also: TDes8 TDes16

Typedef TPtr

typedef TPtr16 TPtr

Defines a build-independent modifiable pointer descriptor.

A 16-bit build variant is generated for a Unicode, non-kernel mode build.

A build-independent type should always be used unless an explicit 8-bit or 16-bit type is required.

See also: TPtr8 TPtr16

Typedef HBufC

typedef HBufC16 HBufC

Defines a build-independent heap descriptor.

A 16-bit build variant is generated for a Unicode, non-kernel mode build.

A build-independent type should always be used unless an explicit 8-bit or 16-bit type is required.

See also: HBufC8 HBufC16

Typedef TDesOverflow

typedef TDes16Overflow TDesOverflow

Defines a build-independent descriptor overflow handler.

A 16-bit build variant is generated for a Unicode, non-kernel mode build.

A build-independent type should always be used unless an explicit 8-bit or 16-bit type is required.

See also: TDes8Overflow TDes16Overflow

Typedef RBuf

typedef RBuf16 RBuf

Defines a build-independent resizable buffer descriptor.

A 16-bit build variant is generated for a Unicode, non-kernel mode build.

A build-independent type should always be used unless an explicit 8-bit or 16-bit type is required.

See also: RBuf8 RBuf16

Typedef TBufCBase

typedef TBufCBase16 TBufCBase

Typedef __TRefDesC

typedef TRefByValue< const TDesC >__TRefDesC

Value reference used in operator TLitC::__TRefDesC().

See also: TRefByValue

_LIT ( KNullDesC, "" )

_LIT(KNullDesC,
""
)

Defines an empty or null literal descriptor.

This is the build independent form. An 8 bit build variant is generated for a non-Unicode build; a 16 bit build variant is generated for a Unicode build.

_LIT8 ( KNullDesC8, "" )

_LIT8(KNullDesC8,
""
)

Defines an empty or null literal descriptor for use with 8-bit descriptors.

_LIT16 ( KNullDesC16, "" )

_LIT16(KNullDesC16,
""
)

Defines an empty or null literal descriptor for use with 16-bit descriptors

Typedef TName

typedef TBuf< KMaxName >TName

Defines a modifiable buffer descriptor that can contain the name of a reference counting object.

See also: TBuf CObject

Typedef TFullName

typedef TBuf< KMaxFullName >TFullName

Defines a modifiable buffer descriptor that can contain the full name of a reference counting object.

See also: TBuf CObject

Typedef TExitCategoryName

typedef TBuf< KMaxExitCategoryName >TExitCategoryName

Defines a modifiable buffer descriptor to contain the category name identifying the cause of thread or process termination. The buffer takes a maximum length of KMaxExitCategoryName.

See also: RThread::ExitCategory RThread::ExitCategory

Typedef TFileName

typedef TBuf< KMaxFileName >TFileName

A buffer that can contain the name of a file. The name can have a maximum length of KMaxFileName (currently 256 but check the definition of KMaxFileName).

See also: KMaxFileName

Typedef TPath

typedef TBuf< KMaxPath >TPath

A buffer that can contain the name of a path. The name can have a maximum length of KMaxPath (currently 256 but check the definition of KMaxPath).

See also: KMaxPath

Typedef TVersionName

typedef TBuf< KMaxVersionName >TVersionName

Version name type.

This is a buffer descriptor with a maximum length of KMaxVersionName. A TVersion object returns the formatted character representation of its version information in a descriptor of this type.

See also: TVersion

Typedef TUidName

typedef TBuf< KMaxUidName >TUidName

Defines a modifiable buffer descriptor for the text form of the UID. The descriptor has a maximum length of KMaxUidName and is used to contain the standard text format returned by the function TUid::Name().

See also: TUid::Name

KNullUid

Defines a null UID

_LIT_SECURE_ID

Macro for compile-time definition of a secure ID

_LIT_VENDOR_ID

Macro for compile-time definition of a vendor ID

__SYMBIAN_KERNEL_HYBRID_HEAP__

Enum THeapType

Heap types.

EnumeratorValueDescription
EHeapTypeHybrid0xdfceacb9

Typedef __NullPMF

typedef void(OnlyCreateWithNull::*__NullPMF

operator== ( RMessagePtr2, RMessagePtr2 )

TBool operator==(RMessagePtr2aLeft,
RMessagePtr2aRight
)[inline]

operator!= ( RMessagePtr2, RMessagePtr2 )

TBool operator!=(RMessagePtr2aLeft,
RMessagePtr2aRight
)[inline]

__IPC_V2_PRESENT__

Typedef TMediaPassword

typedef TBuf8< KMaxMediaPassword >TMediaPassword

Defines an 8-bit modifiable buffer descriptor to contain passwords when dealing with password security support in a file server session.

The descriptor takes a maximum length of KMaxMediaPassword.

See also: KMaxMediaPassword

KScFlagBufOffsetListInUse

const TUintKScFlagBufOffsetListInUse

A configuration flag for the shared chunk buffer configuration class (used by the multimedia device drivers). This being set signifies that a buffer offset list follows the buffer configuration class. This list holds the offset of each buffer.

KScFlagUseGuardPages

const TUintKScFlagUseGuardPages

A configuration flag for the shared chunk buffer configuration class (used by the multimedia device drivers). This being set is a suggestion that the shared chunk should be configured leaving guard pages around each buffers.

KCapabilitySetMaxSize

const TIntKCapabilitySetMaxSize

Maximum size of capability set

KMaxSecurityPolicySize

const TIntKMaxSecurityPolicySize

Maximum size of any future extension to TSecurityPolicy

__SECURITY_INFO_DEFINED__

Typedef TSecurityPolicyBuf

typedef TPckgBuf< TSecurityPolicy >TSecurityPolicyBuf

Provides a TPkcgBuf wrapper for a descriptorised TSecurityPolicy. This a suitable container for passing a security policy across IPC.

CAPABILITY_AS_TUINT8

A macro to cast a TCapability to a TUint8.

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

FOUR_TUINT8

A macro to construct a TUint32 from four TUint8s. The TUint32 is in BigEndian ordering useful for class layout rather than number generation.

_INIT_SECURITY_POLICY_FAIL

Macro for compile-time initialisation of a security policy object that always fails. That is, checks against this policy will always fail, irrespective of the security attributes of the item being checked.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

_LIT_SECURITY_POLICY_FAIL

Macro for compile-time definition of a security policy object that always fails. That is, checks against this policy will always fail, irrespective of the security attributes of the item being checked.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

_INIT_SECURITY_POLICY_PASS

Macro for compile-time initialisation of a security policy object that always passes. That is, checks against this policy will always pass, irrespective of the security attributes of the item being checked.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

_LIT_SECURITY_POLICY_PASS

Macro for compile-time definition of a security policy object that always passes. That is, checks against this policy will always pass, irrespective of the security attributes of the item being checked.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

_INIT_SECURITY_POLICY_C7

Macro for compile-time initialisation of a security policy object The policy will check for seven capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_C7

Macro for compile-time definition of a security policy object The policy will check for seven capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_C6

Macro for compile-time initialisation of a security policy object The policy will check for six capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_C6

Macro for compile-time definition of a security policy object The policy will check for six capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_C5

Macro for compile-time initialisation of a security policy object The policy will check for five capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_C5

Macro for compile-time definition of a security policy object The policy will check for five capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_C4

Macro for compile-time initialisation of a security policy object The policy will check for four capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_C4

Macro for compile-time definition of a security policy object The policy will check for four capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_C3

Macro for compile-time initialisation of a security policy object The policy will check for three capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_C3

Macro for compile-time definition of a security policy object The policy will check for three capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_C2

Macro for compile-time initialisation of a security policy object The policy will check for two capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_C2

Macro for compile-time definition of a security policy object The policy will check for two capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_C1

Macro for compile-time initialisation of a security policy object The policy will check for one capability.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_C1

Macro for compile-time definition of a security policy object The policy will check for one capability.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning will be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_S3

Macro for compile-time initialisation of a security policy object The policy will check for a secure ID and three capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_S3

Macro for compile-time definition of a security policy object The policy will check for a secure ID and three capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_S2

Macro for compile-time initialisation of a security policy object The policy will check for a secure ID and two capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_S2

Macro for compile-time definition of a security policy object The policy will check for a secure ID and two capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_S1

Macro for compile-time initialisation of a security policy object The policy will check for a secure ID and one capability.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_S1

Macro for compile-time definition of a security policy object The policy will check for a secure ID and one capability.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_S0

Macro for compile-time initialisation of a security policy object The policy will check for a secure ID.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

_LIT_SECURITY_POLICY_S0

Macro for compile-time definition of a security policy object The policy will check for a secure ID.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

_INIT_SECURITY_POLICY_V3

Macro for compile-time initialisation of a security policy object The policy will check for a vendor ID and three capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_V3

Macro for compile-time definition of a security policy object The policy will check for a vendor ID and three capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_V2

Macro for compile-time initialisation of a security policy object The policy will check for a vendor ID and two capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_V2

Macro for compile-time definition of a security policy object The policy will check for a vendor ID and two capabilities.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_V1

Macro for compile-time initialisation of a security policy object The policy will check for a vendor ID and one capability.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_LIT_SECURITY_POLICY_V1

Macro for compile-time definition of a security policy object The policy will check for a vendor ID and one capability.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

If an invlid capability value is specified then, dependant on the compiler, a compile time error or warning be produced which includes the label "__invalid_capability_value"

_INIT_SECURITY_POLICY_V0

Macro for compile-time initialisation of a security policy object The policy will check for a vendor ID.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

_LIT_SECURITY_POLICY_V0

Macro for compile-time definition of a security policy object The policy will check for a vendor ID.

The object declared has an implicit conversion to const TSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicy& may be effected by using the function call operator n().

KMaxSerialNumLength

Typedef TMediaSerialNumber

typedef TBuf8< 64 >TMediaSerialNumber

Typedef TModuleMemoryInfo

typedef TProcessMemoryInfo TModuleMemoryInfo

Defines a more useful synonym for TProcessMemoryInfo.

Typedef TGeneralIdentityRelation

typedef TBool(*TGeneralIdentityRelation

Defines a function type used by a TIdentityRelation object.

A function of this type implements an algorithm for determining whether two objects match.

See also: TIdentityRelation

Typedef TGeneralLinearOrder

typedef TInt(*TGeneralLinearOrder

Defines a function type used by a TLinearOrder object

A function of this type implements an algorithm that determines the order of two objects.

See also: TLinearOrder

Enum TArrayFindMode

EnumeratorValueDescription
EArrayFindMode_Any0

Indicates that any element in a block of duplicate elements can be returned by a search function.

Note that using this mode, there can be no guarantee that the element returned by the search functions will be the same if the size of the array changes between successive calls to those functions.

EArrayFindMode_First1

Indicates that the first element in a block of duplicate elements is returned.

EArrayFindMode_Last2

Indicates that the first element after the last element in a block of duplicate elements is returned.

EArrayFindMode_Limit3

TRAP

Executes the set of C++ statements _s under a trap harness.

Use this macro as a C++ statement.

_r must be a TInt which has already been declared; if any of the C++ statements _s leaves, then the leave code is returned in _r, otherwise _r is set to KErrNone.

_s can consist of multiple C++ statements; in theory, _s can consist of any legal C++ code but in practice, such statements consist of simple function calls, e.g. Foo() or an assignment of some value to the result of a function call, e.g. functionValue=GetFoo().

A cleanup stack is constructed for the set of C++ statements _s. If any function in _s leaves, objects pushed to the cleanup stack are cleaned-up. In addition, if any of the C++ statements in _s leaves, then remaining C++ code in _s is not executed and any variables which are assigned within that remaining code are not defined.

See also: TRAPD

TRAPD

Executes the set of C++ statements _s under a trap harness.

Use this macro in the same way as you would TRAP, except that the variable _r is defined as part of the macro (and is therefore valid for the rest of the block in which the macro occurs). Often, this saves a line of code.

See also: TRAP

TRAP_IGNORE

Executes the set of C++ statements _s under a trap harness. Any leave code generated is ignored.

Use this macro as a C++ statement.

This macro is functionally equivalent to:
	TInt x;
	TRAP(x,_s)
or
	TRAPD(x,_s)
where the value in 'x' is not used by any subsequent code.

_s can consist of multiple C++ statements; in theory, _s can consist of any legal C++ code but in practice, such statements consist of simple function calls, e.g. Foo() or an assignment of some value to the result of a function call, e.g. functionValue=GetFoo().

A cleanup stack is constructed for the set of C++ statements _s. If any function in _s leaves, objects pushed to the cleanup stack are cleaned-up. In addition, if any of the C++ statements in _s leaves, then remaining C++ code in _s is not executed and any variables which are assigned within that remaining code are not defined.

See also: TRAPD TRAP

__OPERATOR_NEW_DECLARED__

operator new ( TUint )

GLREF_C TAny *operator new(TUintaSize)

operator new ( TUint, TUint )

GLREF_C TAny *operator new(TUintaSize,
TUintanExtraSize
)

operator delete ( TAny * )

GLREF_C voidoperator delete(TAny *aPtr)

operator new[] ( TUint )

GLREF_C TAny *operator new[](TUintaSize)

operator delete[] ( TAny * )

GLREF_C voidoperator delete[](TAny *aPtr)

operator new ( TUint, TAny * )

TAny *operator new(TUintaSize,
TAny *aBase
)[inline]

operator delete ( TAny *, TAny * )

voidoperator delete(TAny *aPtr,
TAny *aBase
)[inline]

operator new[] ( TUint, TAny * )

TAny *operator new[](TUintaSize,
TAny *aBase
)[inline]

operator delete[] ( TAny *, TAny * )

voidoperator delete[](TAny *aPtr,
TAny *aBase
)[inline]

operator== ( TTrue, volatile const )

TBool operator==(TTrue,
volatile constTBool
)

operator== ( volatile const, TTrue )

TBool operator==(volatile constTBool,
TTrue
)

operator!= ( TTrue, volatile const )

TBool operator!=(TTrue,
volatile constTBool
)

operator!= ( volatile const, TTrue )

TBool operator!=(volatile constTBool,
TTrue
)

Enum TFileMapMode

A set of values that can be logically or'd together to control how a RFileMap is opened.

EnumeratorValueDescription
EFileMapWrite0x00000001

Open a writable mapping to the file.

When EFileMapWrite is specified it will be possible to write to the file by writing to the addresses mapped by the RFileMap.

EFileMapRemovableMedia0x00000002

Open a mapping to a file stored on removable media.

When EFileMapRemovableMedia is specified files stored on removable media can be memory mapped. If this is not specified then it is not possible to open files stored on removable media. This includes logically removable media, not just physically removable, e.g. files stored on internal eMMC drive which may be removed when USB mass storage mode is active.

Before setting EFileMapRemovableMedia the designer must consider how to cope if the media the file is stored on is removed as any access to a file mapping on removable media may result in the thread panicking.

EFileMapInvalidMask~(EFileMapRemovableMedia | EFileMapWrite)

A mask used when validating a TFileMapMode bitmask.

Enum TGlobalDataType

A set of values specifying which global data elements should be updated/read.

See also: User::GetGlobalData Kern::SetGlobalData Kern::GetGlobalData

EnumeratorValueDescription
EGlobalDataOstFlag0The global enable flag for open system tracing (OST).
EGlobalDataTypeEnd. This must always be last.