e32cmn.h File Reference

#include <e32const.h>
#include <e32des8.h>
#include <e32des16.h>
#include <e32cmn.inl>
#include <e32cmn_private.h>

Go to the source code of this file.

Classes
class	TRefByValue< T >
	A templated class which encapsulates a reference to an object within a wrapper. More...
class	TChar
	Holds a character value and provides a number of utility functions to manipulate it and test its properties. More...
struct	TChar::TCharInfo
	A structure to hold information about a Unicode character. More...
class	TBufC< S >
	A build-independent non-modifiable buffer descriptor. More...
class	TBuf< S >
	A build-independent modifiable buffer descriptor. More...
class	TLitC< S >
	Encapsulates literal text. More...
class	TPckgC< T >
	Packages a non-modifiable pointer descriptor which represents an object of specific type. More...
class	TPckg< T >
	Packages a modifiable pointer descriptor which represents an object of specific type. More...
class	TPckgBuf< T >
	Packages an object into a modifiable buffer descriptor. More...
class	TUid
	A globally unique 32-bit number. More...
class	TUidType
	Encapsulates a set of three unique identifiers (UIDs) which, in combination, identify a system object such as a GUI application or a DLL. More...
class	TSecureId
	A class used to represent the Secure ID of a process or executable image. More...
class	TVendorId
	A class used to represent the Vendor ID of a process or executable image. More...
class	SSecureId
	Structure for compile-time definition of a secure ID. More...
class	SVendorId
	Structure for compile-time definition of a vendor ID. More...
class	TVersion
	Contains version information. More...
class	TRequestStatus
	Indicates the completion status of a request made to a service provider. More...
class	TPoint
	Stores a two-dimensional point in Cartesian co-ordinates. More...
class	TPoint3D
	Stores a three-dimensional point in Cartesian or polar co-ordinates. More...
class	TAngle3D
	Stores the angular spherical coordinates (Phi,Theta) of a three-dimensional point. More...
class	TSize
	Stores a two-dimensional size as a width and a height value. More...
class	THandleInfo
	Information about a kernel object. More...
class	TFindHandle
class	RHandleBase
	A handle to an object. More...
class	RSemaphore
	A handle to a semaphore. More...
class	RFastLock
	A fast semaphore. More...
class	RReadWriteLock
	A read-write lock. More...
class	RBusLogicalChannel
	The user-side handle to a logical channel. More...
class	MAllocator
	Base class for memory allocators. More...
class	RAllocator
	Base class for heaps. More...
struct	RAllocator::SCheckInfo
struct	RAllocator::SRAllocatorBurstFail
class	RHeap
	Represents the default implementation for a heap. More...
struct	RHeap::SDebugCell
	The structure of a heap cell header for an allocated heap cell in a debug build. More...
struct	RHeap::SHeapCellInfo
class	OnlyCreateWithNull
class	RMessagePtr2
	A handle to a message sent by the client to the server. More...
class	RMessage2
	An object that encapsulates the details of a client request. More...
class	TSharedChunkBufConfigBase
	The shared chunk buffer configuration class (used by the multimedia device drivers). More...
class	TCapabilitySet
	Class representing an arbitrary set of capabilities. More...
struct	SCapabilitySet
struct	SSecurityInfo
class	TSecurityInfo
	Class representing all security attributes of a process or DLL. More...
class	TSecurityPolicy
	Class representing a generic security policy. More...
struct	TStaticSecurityPolicy
	Structure for compile-time initialisation of a security policy. More...
class	PlatSec
	Class containing Platform Security related methods. More...
class	TProcessMemoryInfo
	Contains information about the code and data sections belonging to a process. More...
class	TArray< T >
	Generic array. More...
class	TIdentityRelation< T >
	A templated class which packages a function that determines whether two objects of a given class type match. More...
class	DefaultIdentity
	A set of common identity relations for frequently occurring types. More...
class	TLinearOrder< T >
	A templated class which packages a function that determines the order of two objects of a given class type. More...
class	RPointerArrayBase
	Base class used in the derivation of RPointerArray, RArray<TInt>, and RArray<TUint>. More...
class	RPointerArray< T >
	A simple and efficient array of pointers to objects. More...
class	RPointerArray< TAny >
	Array of raw pointers. More...
class	RArrayBase
	Base class used in the derivation of RArray. More...
class	RArray< T >
	A simple and efficient array of fixed length objects. More...
class	RArray< TInt >
	A simple and efficient specialized array of signed integers offering standard array behaviour. More...
class	RArray< TUint >
	Array of unsigned integers. More...
class	TTrap
class	TIpcArgs
	A Version 2 client/server class that clients use to package the arguments to be sent to a server. More...
struct	SInt64
struct	SUint64
struct	SDouble
class	TThreadStackInfo
	Stores information about a thread's stack. More...
struct	TEmulatorImageHeader

Macros
#define	__Size   (sizeof(TUint)/sizeof(TUint8))
#define	KNullUid   TUid::Null()
	Defines a null UID.
#define	_LIT_SECURE_ID(name, value)   const SSecureId name={value}
	Macro for compile-time definition of a secure ID.
#define	_LIT_VENDOR_ID(name, value)   const SVendorId name={value}
	Macro for compile-time definition of a vendor ID.
#define	__SYMBIAN_KERNEL_HYBRID_HEAP__
#define	__IPC_V2_PRESENT__
#define	__SECURITY_INFO_DEFINED__
#define	CAPABILITY_AS_TUINT8(cap)
	A macro to cast a TCapability to a TUint8.
#define	FOUR_TUINT8(i1, i2, i3, i4)
	A macro to construct a TUint32 from four TUint8s.
#define	_INIT_SECURITY_POLICY_FAIL
	Macro for compile-time initialisation of a security policy object that always fails.
#define	_LIT_SECURITY_POLICY_FAIL(n)   const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_FAIL
	Macro for compile-time definition of a security policy object that always fails.
#define	_INIT_SECURITY_POLICY_PASS
	Macro for compile-time initialisation of a security policy object that always passes.
#define	_LIT_SECURITY_POLICY_PASS(n)   const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_PASS
	Macro for compile-time definition of a security policy object that always passes.
#define	_INIT_SECURITY_POLICY_C7(c1, c2, c3, c4, c5, c6, c7)
	Macro for compile-time initialisation of a security policy object The policy will check for seven capabilities.
#define	_LIT_SECURITY_POLICY_C7(n, c1, c2, c3, c4, c5, c6, c7)    const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_C7(c1,c2,c3,c4,c5,c6,c7)
	Macro for compile-time definition of a security policy object The policy will check for seven capabilities.
#define	_INIT_SECURITY_POLICY_C6(c1, c2, c3, c4, c5, c6)    _INIT_SECURITY_POLICY_C7(c1,c2,c3,c4,c5,c6,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for six capabilities.
#define	_LIT_SECURITY_POLICY_C6(n, c1, c2, c3, c4, c5, c6)    _LIT_SECURITY_POLICY_C7(n,c1,c2,c3,c4,c5,c6,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for six capabilities.
#define	_INIT_SECURITY_POLICY_C5(c1, c2, c3, c4, c5)    _INIT_SECURITY_POLICY_C7(c1,c2,c3,c4,c5,ECapability_None,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for five capabilities.
#define	_LIT_SECURITY_POLICY_C5(n, c1, c2, c3, c4, c5)    _LIT_SECURITY_POLICY_C7(n,c1,c2,c3,c4,c5,ECapability_None,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for five capabilities.
#define	_INIT_SECURITY_POLICY_C4(c1, c2, c3, c4)    _INIT_SECURITY_POLICY_C7(c1,c2,c3,c4,ECapability_None,ECapability_None,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for four capabilities.
#define	_LIT_SECURITY_POLICY_C4(n, c1, c2, c3, c4)    _LIT_SECURITY_POLICY_C7(n,c1,c2,c3,c4,ECapability_None,ECapability_None,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for four capabilities.
#define	_INIT_SECURITY_POLICY_C3(c1, c2, c3)
	Macro for compile-time initialisation of a security policy object The policy will check for three capabilities.
#define	_LIT_SECURITY_POLICY_C3(n, c1, c2, c3)    const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_C3(c1,c2,c3)
	Macro for compile-time definition of a security policy object The policy will check for three capabilities.
#define	_INIT_SECURITY_POLICY_C2(c1, c2)    _INIT_SECURITY_POLICY_C3(c1,c2,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for two capabilities.
#define	_LIT_SECURITY_POLICY_C2(n, c1, c2)    _LIT_SECURITY_POLICY_C3(n,c1,c2,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for two capabilities.
#define	_INIT_SECURITY_POLICY_C1(c1)    _INIT_SECURITY_POLICY_C3(c1,ECapability_None,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for one capability.
#define	_LIT_SECURITY_POLICY_C1(n, c1)    _LIT_SECURITY_POLICY_C3(n,c1,ECapability_None,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for one capability.
#define	_INIT_SECURITY_POLICY_S3(sid, c1, c2, c3)
	Macro for compile-time initialisation of a security policy object The policy will check for a secure ID and three capabilities.
#define	_LIT_SECURITY_POLICY_S3(n, sid, c1, c2, c3)    const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_S3(sid,c1,c2,c3)
	Macro for compile-time definition of a security policy object The policy will check for a secure ID and three capabilities.
#define	_INIT_SECURITY_POLICY_S2(sid, c1, c2)    _INIT_SECURITY_POLICY_S3(sid,c1,c2,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for a secure ID and two capabilities.
#define	_LIT_SECURITY_POLICY_S2(n, sid, c1, c2)    _LIT_SECURITY_POLICY_S3(n,sid,c1,c2,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for a secure ID and two capabilities.
#define	_INIT_SECURITY_POLICY_S1(sid, c1)    _INIT_SECURITY_POLICY_S3(sid,c1,ECapability_None,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for a secure ID and one capability.
#define	_LIT_SECURITY_POLICY_S1(n, sid, c1)    _LIT_SECURITY_POLICY_S3(n,sid,c1,ECapability_None,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for a secure ID and one capability.
#define	_INIT_SECURITY_POLICY_S0(sid)    _INIT_SECURITY_POLICY_S3(sid,ECapability_None,ECapability_None,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for a secure ID.
#define	_LIT_SECURITY_POLICY_S0(n, sid)    _LIT_SECURITY_POLICY_S3(n,sid,ECapability_None,ECapability_None,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for a secure ID.
#define	_INIT_SECURITY_POLICY_V3(vid, c1, c2, c3)
	Macro for compile-time initialisation of a security policy object The policy will check for a vendor ID and three capabilities.
#define	_LIT_SECURITY_POLICY_V3(n, vid, c1, c2, c3)    const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_V3(vid,c1,c2,c3)
	Macro for compile-time definition of a security policy object The policy will check for a vendor ID and three capabilities.
#define	_INIT_SECURITY_POLICY_V2(vid, c1, c2)    _INIT_SECURITY_POLICY_V3(vid,c1,c2,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for a vendor ID and two capabilities.
#define	_LIT_SECURITY_POLICY_V2(n, vid, c1, c2)    _LIT_SECURITY_POLICY_V3(n,vid,c1,c2,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for a vendor ID and two capabilities.
#define	_INIT_SECURITY_POLICY_V1(vid, c1)    _INIT_SECURITY_POLICY_V3(vid,c1,ECapability_None,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for a vendor ID and one capability.
#define	_LIT_SECURITY_POLICY_V1(n, vid, c1)    _LIT_SECURITY_POLICY_V3(n,vid,c1,ECapability_None,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for a vendor ID and one capability.
#define	_INIT_SECURITY_POLICY_V0(vid)    _INIT_SECURITY_POLICY_V3(vid,ECapability_None,ECapability_None,ECapability_None)
	Macro for compile-time initialisation of a security policy object The policy will check for a vendor ID.
#define	_LIT_SECURITY_POLICY_V0(n, vid)    _LIT_SECURITY_POLICY_V3(n,vid,ECapability_None,ECapability_None,ECapability_None)
	Macro for compile-time definition of a security policy object The policy will check for a vendor ID.
#define	KMaxSerialNumLength   64
#define	TRAP(_r, _s)   {TTrap __t;if (__t.Trap(_r)==0){_s;TTrap::UnTrap();}}
	Executes the set of C++ statements _s under a trap harness.
#define	TRAPD(_r, _s)   TInt _r;{TTrap __t;if (__t.Trap(_r)==0){_s;TTrap::UnTrap();}}
	Executes the set of C++ statements _s under a trap harness.
#define	TRAP_IGNORE(_s)   {TInt _ignore;TTrap __t;if (__t.Trap(_ignore)==0){_s;TTrap::UnTrap();}}
	Executes the set of C++ statements _s under a trap harness.
#define	__OPERATOR_NEW_DECLARED__

Typedefs
typedef TDesC8	TDesC
	Defines a build-independent non-modifiable descriptor.
typedef TPtrC8	TPtrC
	Defines a build-independent non-modifiable pointer descriptor.
typedef TDes8	TDes
	Defines a build-independent modifiable descriptor.
typedef TPtr8	TPtr
	Defines a build-independent modifiable pointer descriptor.
typedef HBufC8	HBufC
	Defines a build-independent heap descriptor.
typedef TDes8Overflow	TDesOverflow
	Defines a build-independent descriptor overflow handler.
typedef RBuf8	RBuf
	Defines a build-independent resizable buffer descriptor.
typedef TBufCBase8	TBufCBase
typedef TRefByValue< const TDesC >	__TRefDesC
	Value reference used in operator TLitC::__TRefDesC().
typedef TBuf< KMaxName >	TName
	Defines a modifiable buffer descriptor that can contain the name of a reference counting object.
typedef TBuf< KMaxFullName >	TFullName
	Defines a modifiable buffer descriptor that can contain the full name of a reference counting object.
typedef TBuf< KMaxExitCategoryName >	TExitCategoryName
	Defines a modifiable buffer descriptor to contain the category name identifying the cause of thread or process termination.
typedef TBuf< KMaxFileName >	TFileName
	A buffer that can contain the name of a file.
typedef TBuf< KMaxPath >	TPath
	A buffer that can contain the name of a path.
typedef TBuf< KMaxVersionName >	TVersionName
	Version name type.
typedef TBuf< KMaxUidName >	TUidName
	Defines a modifiable buffer descriptor for the text form of the UID.
typedef void(OnlyCreateWithNull::*	__NullPMF) ()
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.
typedef TPckgBuf< TSecurityPolicy >	TSecurityPolicyBuf
	Provides a TPkcgBuf wrapper for a descriptorised TSecurityPolicy.
typedef TBuf8< KMaxSerialNumLength >	TMediaSerialNumber
typedef TProcessMemoryInfo	TModuleMemoryInfo
	Defines a more useful synonym for TProcessMemoryInfo.
typedef TBool(*	TGeneralIdentityRelation) (const TAny *, const TAny *)
	Defines a function type used by a TIdentityRelation object.
typedef TInt(*	TGeneralLinearOrder) (const TAny *, const TAny *)
	Defines a function type used by a TLinearOrder object.

Enumerations
enum	__invalid_capability_value
	A dummy enum for use by the CAPABILITY_AS_TUINT8 macro. More...
enum	TArrayFindMode { EArrayFindMode_Any = 0 , EArrayFindMode_First = 1 , EArrayFindMode_Last = 2 , EArrayFindMode_Limit = 3 }

Functions
IMPORT_C TInt	memcompare (const TUint8 *aLeft, TInt aLeftLen, const TUint8 *aRight, TInt aRightLen)
	A Nanokernel utility function that compares two memory buffers for equality.
IMPORT_C TAny *	wordmove (TAny *aTrg, const TAny *aSrc, unsigned int aLength)
	A Nanokernel utility function that moves (copies) bytes in memory.
IMPORT_C TAny *	memclr (TAny *aTrg, unsigned int aLength)
	A Nanokernel utility function that sets the specified number of bytes to binary zero.
IMPORT_C TAny *	memset (TAny *aTrg, TInt aValue, unsigned int aLength)
	A Nanokernel utility function that sets all of the specified number of bytes to the specified fill value.
IMPORT_C TAny *	memcpy (TAny *aTrg, const TAny *aSrc, unsigned int aLength)
	A Nanokernel utility function that copies bytes in memory.
IMPORT_C TAny *	memmove (TAny *aTrg, const TAny *aSrc, unsigned int aLength)
	A Nanokernel utility function that moves (copies) bytes in memory.
TInt	Lim (TInt aVal, TUint aLimit)
	Tests whether the specified value is less than or equal to the specified upper limit.
TInt	LimX (TInt aVal, TUint aLimit)
	Tests whether the specified value is strictly less than the specified upper limit.
template<class T >
T	Min (T aLeft, T aRight)
	Returns the smaller of two values.
template<class T >
T	Min (T aLeft, TUint aRight)
	Returns the smaller of two objects, where the right hand object is a treated as a TInt for the purpose of comparison.
template<class T >
T	Max (T aLeft, T aRight)
	Returns the larger of two values.
template<class T >
T	Max (T aLeft, TUint aRight)
	Returns the larger of two objects, where the right hand object is a treated as a TInt for the purpose of comparison.
template<class T >
T	Abs (T aVal)
	Returns an absolute value.
template<class T >
TBool	Rng (T aMin, T aVal, T aMax)
	Determines whether a specified value lies within a defined range of values.
template<class T , class S >
T *	PtrAdd (T *aPtr, S aVal)
	Adds a value to a pointer.
template<class T , class S >
T *	PtrSub (T *aPtr, S aVal)
	Subtracts a value from a pointer.
template<class T >
T	Align2 (T aValue)
	Aligns the specified value onto a 2-byte boundary.
template<class T >
T	Align4 (T aValue)
	Aligns the specified value onto a 4-byte boundary.
	_LIT (KNullDesC,"")
	Defines an empty or null literal descriptor.
	_LIT8 (KNullDesC8,"")
	Defines an empty or null literal descriptor for use with 8-bit descriptors.
	_LIT16 (KNullDesC16,"")
	Defines an empty or null literal descriptor for use with 16-bit descriptors.
TBool	operator== (RMessagePtr2 aLeft, RMessagePtr2 aRight)
TBool	operator!= (RMessagePtr2 aLeft, RMessagePtr2 aRight)
GLREF_C TAny *	operator new (TUint aSize) __NO_THROW
GLREF_C TAny *	operator new (TUint aSize, TUint anExtraSize) __NO_THROW
GLREF_C void	operator delete (TAny *aPtr) __NO_THROW
GLREF_C TAny *	operator new[] (TUint aSize) __NO_THROW
GLREF_C void	operator delete[] (TAny *aPtr) __NO_THROW
TAny *	operator new (TUint aSize, TAny *aBase) __NO_THROW
void	operator delete (TAny *aPtr, TAny *aBase) __NO_THROW
TAny *	operator new[] (TUint aSize, TAny *aBase) __NO_THROW
void	operator delete[] (TAny *aPtr, TAny *aBase) __NO_THROW
TBool	operator== (TTrue, volatile const TBool)
TBool	operator== (volatile const TBool, TTrue)
TBool	operator!= (TTrue, volatile const TBool)
TBool	operator!= (volatile const TBool, TTrue)

Variables
const TUint	KScFlagBufOffsetListInUse =0x00000001
	A configuration flag for the shared chunk buffer configuration class (used by the multimedia device drivers).
const TUint	KScFlagUseGuardPages =0x00000002
	A configuration flag for the shared chunk buffer configuration class (used by the multimedia device drivers).
const TInt	KCapabilitySetMaxSize = (((TInt)ECapability_HardLimit + 7)>>3)
	Maximum size of capability set.
const TInt	KMaxSecurityPolicySize = KCapabilitySetMaxSize + 3*sizeof(TUint32)
	Maximum size of any future extension to TSecurityPolicy.

Macro Definition Documentation

__IPC_V2_PRESENT__

#define __IPC_V2_PRESENT__

Definition at line 3454 of file e32cmn.h.

__OPERATOR_NEW_DECLARED__

#define __OPERATOR_NEW_DECLARED__

Definition at line 6675 of file e32cmn.h.

__SECURITY_INFO_DEFINED__

#define __SECURITY_INFO_DEFINED__

Definition at line 3652 of file e32cmn.h.

__Size

#define __Size   (sizeof(TUint)/sizeof(TUint8))

Definition at line 1324 of file e32cmn.h.

__SYMBIAN_KERNEL_HYBRID_HEAP__

#define __SYMBIAN_KERNEL_HYBRID_HEAP__

Definition at line 3003 of file e32cmn.h.

_INIT_SECURITY_POLICY_C1

#define _INIT_SECURITY_POLICY_C1

(

c1

)

_INIT_SECURITY_POLICY_C3(c1,ECapability_None,ECapability_None)

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"

Parameters

c1	The first capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4540 of file e32cmn.h.

_INIT_SECURITY_POLICY_C2

#define _INIT_SECURITY_POLICY_C2	(		c1,
			c2
	)		_INIT_SECURITY_POLICY_C3(c1,c2,ECapability_None)

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"

Parameters

c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4494 of file e32cmn.h.

_INIT_SECURITY_POLICY_C3

#define _INIT_SECURITY_POLICY_C3	(		c1,
			c2,
			c3
	)

Value:

    {                                                                       \
    FOUR_TUINT8(                                                            \
        (TUint8)TSecurityPolicy::ETypeC3,                                   \
        CAPABILITY_AS_TUINT8(c1),                                           \
        CAPABILITY_AS_TUINT8(c2),                                           \
        CAPABILITY_AS_TUINT8(c3)                                            \
    ),                                                                      \
    (TUint32)0xffffffff                                                     \
    }

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"

Parameters

c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4438 of file e32cmn.h.

_INIT_SECURITY_POLICY_C4

#define _INIT_SECURITY_POLICY_C4	(		c1,
			c2,
			c3,
			c4
	)		_INIT_SECURITY_POLICY_C7(c1,c2,c3,c4,ECapability_None,ECapability_None,ECapability_None)

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"

Parameters

c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)
c4	The fourth capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4388 of file e32cmn.h.

_INIT_SECURITY_POLICY_C5

#define _INIT_SECURITY_POLICY_C5	(		c1,
			c2,
			c3,
			c4,
			c5
	)		_INIT_SECURITY_POLICY_C7(c1,c2,c3,c4,c5,ECapability_None,ECapability_None)

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"

Parameters

c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)
c4	The fourth capability to check (enumerator of TCapability)
c5	The fifth capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4336 of file e32cmn.h.

_INIT_SECURITY_POLICY_C6

#define _INIT_SECURITY_POLICY_C6	(		c1,
			c2,
			c3,
			c4,
			c5,
			c6
	)		_INIT_SECURITY_POLICY_C7(c1,c2,c3,c4,c5,c6,ECapability_None)

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"

Parameters

c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)
c4	The fourth capability to check (enumerator of TCapability)
c5	The fifth capability to check (enumerator of TCapability)
c6	The sixth capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4282 of file e32cmn.h.

_INIT_SECURITY_POLICY_C7

#define _INIT_SECURITY_POLICY_C7	(		c1,
			c2,
			c3,
			c4,
			c5,
			c6,
			c7
	)

Value:

    {                                                                       \
    FOUR_TUINT8(                                                            \
        (TUint8)TSecurityPolicy::ETypeC7,                                   \
        CAPABILITY_AS_TUINT8(c1),                                           \
        CAPABILITY_AS_TUINT8(c2),                                           \
        CAPABILITY_AS_TUINT8(c3)                                            \
    ),                                                                      \
    FOUR_TUINT8(                                                            \
        CAPABILITY_AS_TUINT8(c4),                                           \
        CAPABILITY_AS_TUINT8(c5),                                           \
        CAPABILITY_AS_TUINT8(c6),                                           \
        CAPABILITY_AS_TUINT8(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"

Parameters

c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)
c4	The fourth capability to check (enumerator of TCapability)
c5	The fifth capability to check (enumerator of TCapability)
c6	The sixth capability to check (enumerator of TCapability)
c7	The seventh capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4213 of file e32cmn.h.

_INIT_SECURITY_POLICY_FAIL

#define _INIT_SECURITY_POLICY_FAIL

Value:

    {                                                                       \
    FOUR_TUINT8(                                                            \
        (TUint8)TSecurityPolicy::ETypeFail,                                 \
        (TUint8)0xff,                                                       \
        (TUint8)0xff,                                                       \
        (TUint8)0xff                                                        \
    ),                                                                      \
    (TUint32)0xffffffff                                                     \
    }

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().

API status

Published to all clients. Released API.

Definition at line 4118 of file e32cmn.h.

_INIT_SECURITY_POLICY_PASS

#define _INIT_SECURITY_POLICY_PASS

Value:

    {                                                                       \
    FOUR_TUINT8(                                                            \
        (TUint8)TSecurityPolicy::ETypePass,                                 \
        (TUint8)0xff,                                                       \
        (TUint8)0xff,                                                       \
        (TUint8)0xff                                                        \
    ),                                                                      \
    (TUint32)0xffffffff                                                     \
    }

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().

API status

Published to all clients. Released API.

Definition at line 4160 of file e32cmn.h.

_INIT_SECURITY_POLICY_S0

#define _INIT_SECURITY_POLICY_S0

(

sid

)

_INIT_SECURITY_POLICY_S3(sid,ECapability_None,ECapability_None,ECapability_None)

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().

Parameters

sid	The SID value to check for

API status

Published to all clients. Released API.

Definition at line 4736 of file e32cmn.h.

_INIT_SECURITY_POLICY_S1

#define _INIT_SECURITY_POLICY_S1	(		sid,
			c1
	)		_INIT_SECURITY_POLICY_S3(sid,c1,ECapability_None,ECapability_None)

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"

Parameters

sid	The SID value to check for
c1	The first capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4694 of file e32cmn.h.

_INIT_SECURITY_POLICY_S2

#define _INIT_SECURITY_POLICY_S2	(		sid,
			c1,
			c2
	)		_INIT_SECURITY_POLICY_S3(sid,c1,c2,ECapability_None)

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"

Parameters

sid	The SID value to check for
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4646 of file e32cmn.h.

_INIT_SECURITY_POLICY_S3

#define _INIT_SECURITY_POLICY_S3	(		sid,
			c1,
			c2,
			c3
	)

Value:

    {                                                                       \
    FOUR_TUINT8(                                                            \
        (TUint8)TSecurityPolicy::ETypeS3,                                   \
        CAPABILITY_AS_TUINT8(c1),                                           \
        CAPABILITY_AS_TUINT8(c2),                                           \
        CAPABILITY_AS_TUINT8(c3)                                            \
    ),                                                                      \
    (TUint32)(sid)                                                          \
    }

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"

Parameters

sid	The SID value to check for
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4588 of file e32cmn.h.

_INIT_SECURITY_POLICY_V0

#define _INIT_SECURITY_POLICY_V0

(

vid

)

_INIT_SECURITY_POLICY_V3(vid,ECapability_None,ECapability_None,ECapability_None)

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().

Parameters

vid	The VID value to check for

API status

Published to all clients. Released API.

Definition at line 4928 of file e32cmn.h.

_INIT_SECURITY_POLICY_V1

#define _INIT_SECURITY_POLICY_V1	(		vid,
			c1
	)		_INIT_SECURITY_POLICY_V3(vid,c1,ECapability_None,ECapability_None)

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"

Parameters

vid	The VID value to check for
c1	The first capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4886 of file e32cmn.h.

_INIT_SECURITY_POLICY_V2

#define _INIT_SECURITY_POLICY_V2	(		vid,
			c1,
			c2
	)		_INIT_SECURITY_POLICY_V3(vid,c1,c2,ECapability_None)

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"

Parameters

vid	The VID value to check for
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4838 of file e32cmn.h.

_INIT_SECURITY_POLICY_V3

#define _INIT_SECURITY_POLICY_V3	(		vid,
			c1,
			c2,
			c3
	)

Value:

    {                                                                       \
    FOUR_TUINT8(                                                            \
        (TUint8)TSecurityPolicy::ETypeV3,                                   \
        CAPABILITY_AS_TUINT8(c1),                                           \
        CAPABILITY_AS_TUINT8(c2),                                           \
        CAPABILITY_AS_TUINT8(c3)                                            \
    ),                                                                      \
    (TUint32)(vid)                                                          \
    }

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"

Parameters

vid	The VID value to check for
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4780 of file e32cmn.h.

_LIT_SECURE_ID

#define _LIT_SECURE_ID	(		name,
			value
	)		const SSecureId name={value}

Macro for compile-time definition of a secure ID.

Parameters

name	Name to use for secure ID
value	Value of secure ID

API status

Published to all clients. Released API.

Definition at line 2158 of file e32cmn.h.

_LIT_SECURITY_POLICY_C1

#define _LIT_SECURITY_POLICY_C1	(		n,
			c1
	)		_LIT_SECURITY_POLICY_C3(n,c1,ECapability_None,ECapability_None)

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"

Parameters

n	Name to use for policy object
c1	The first capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4563 of file e32cmn.h.

_LIT_SECURITY_POLICY_C2

#define _LIT_SECURITY_POLICY_C2	(		n,
			c1,
			c2
	)		_LIT_SECURITY_POLICY_C3(n,c1,c2,ECapability_None)

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"

Parameters

n	Name to use for policy object
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4518 of file e32cmn.h.

_LIT_SECURITY_POLICY_C3

#define _LIT_SECURITY_POLICY_C3	(		n,
			c1,
			c2,
			c3
	)		const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_C3(c1,c2,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"

Parameters

n	Name to use for policy object
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4471 of file e32cmn.h.

_LIT_SECURITY_POLICY_C4

#define _LIT_SECURITY_POLICY_C4	(		n,
			c1,
			c2,
			c3,
			c4
	)		_LIT_SECURITY_POLICY_C7(n,c1,c2,c3,c4,ECapability_None,ECapability_None,ECapability_None)

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"

Parameters

n	Name to use for policy object
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)
c4	The fourth capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4414 of file e32cmn.h.

_LIT_SECURITY_POLICY_C5

#define _LIT_SECURITY_POLICY_C5	(		n,
			c1,
			c2,
			c3,
			c4,
			c5
	)		_LIT_SECURITY_POLICY_C7(n,c1,c2,c3,c4,c5,ECapability_None,ECapability_None)

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"

Parameters

n	Name to use for policy object
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)
c4	The fourth capability to check (enumerator of TCapability)
c5	The fifth capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4363 of file e32cmn.h.

_LIT_SECURITY_POLICY_C6

#define _LIT_SECURITY_POLICY_C6	(		n,
			c1,
			c2,
			c3,
			c4,
			c5,
			c6
	)		_LIT_SECURITY_POLICY_C7(n,c1,c2,c3,c4,c5,c6,ECapability_None)

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"

Parameters

n	Name to use for policy object
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)
c4	The fourth capability to check (enumerator of TCapability)
c5	The fifth capability to check (enumerator of TCapability)
c6	The sixth capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4310 of file e32cmn.h.

_LIT_SECURITY_POLICY_C7

#define _LIT_SECURITY_POLICY_C7	(		n,
			c1,
			c2,
			c3,
			c4,
			c5,
			c6,
			c7
	)		const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_C7(c1,c2,c3,c4,c5,c6,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"

Parameters

n	Name to use for policy object
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)
c4	The fourth capability to check (enumerator of TCapability)
c5	The fifth capability to check (enumerator of TCapability)
c6	The sixth capability to check (enumerator of TCapability)
c7	The seventh capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4255 of file e32cmn.h.

_LIT_SECURITY_POLICY_FAIL

#define _LIT_SECURITY_POLICY_FAIL

(

n

)

const TStaticSecurityPolicy n = _INIT_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().

Parameters

n	Name to use for policy object

API status

Published to all clients. Released API.

Definition at line 4144 of file e32cmn.h.

_LIT_SECURITY_POLICY_PASS

#define _LIT_SECURITY_POLICY_PASS

(

n

)

const TStaticSecurityPolicy n = _INIT_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().

Parameters

n	Name to use for policy object

API status

Published to all clients. Released API.

Definition at line 4186 of file e32cmn.h.

_LIT_SECURITY_POLICY_S0

#define _LIT_SECURITY_POLICY_S0	(		n,
			sid
	)		_LIT_SECURITY_POLICY_S3(n,sid,ECapability_None,ECapability_None,ECapability_None)

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().

Parameters

n	Name to use for policy object
sid	The SID value to check for

API status

Published to all clients. Released API.

Definition at line 4755 of file e32cmn.h.

_LIT_SECURITY_POLICY_S1

#define _LIT_SECURITY_POLICY_S1	(		n,
			sid,
			c1
	)		_LIT_SECURITY_POLICY_S3(n,sid,c1,ECapability_None,ECapability_None)

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"

Parameters

n	Name to use for policy object
sid	The SID value to check for
c1	The first capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4718 of file e32cmn.h.

_LIT_SECURITY_POLICY_S2

#define _LIT_SECURITY_POLICY_S2	(		n,
			sid,
			c1,
			c2
	)		_LIT_SECURITY_POLICY_S3(n,sid,c1,c2,ECapability_None)

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"

Parameters

n	Name to use for policy object
sid	The SID value to check for
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4671 of file e32cmn.h.

_LIT_SECURITY_POLICY_S3

#define _LIT_SECURITY_POLICY_S3	(		n,
			sid,
			c1,
			c2,
			c3
	)		const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_S3(sid,c1,c2,c3)

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"

Parameters

n	Name to use for policy object
sid	The SID value to check for
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4622 of file e32cmn.h.

_LIT_SECURITY_POLICY_V0

#define _LIT_SECURITY_POLICY_V0	(		n,
			vid
	)		_LIT_SECURITY_POLICY_V3(n,vid,ECapability_None,ECapability_None,ECapability_None)

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().

Parameters

n	Name to use for policy object
vid	The VID value to check for

API status

Published to all clients. Released API.

Definition at line 4947 of file e32cmn.h.

_LIT_SECURITY_POLICY_V1

#define _LIT_SECURITY_POLICY_V1	(		n,
			vid,
			c1
	)		_LIT_SECURITY_POLICY_V3(n,vid,c1,ECapability_None,ECapability_None)

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"

Parameters

n	Name to use for policy object
vid	The VID value to check for
c1	The first capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4910 of file e32cmn.h.

_LIT_SECURITY_POLICY_V2

#define _LIT_SECURITY_POLICY_V2	(		n,
			vid,
			c1,
			c2
	)		_LIT_SECURITY_POLICY_V3(n,vid,c1,c2,ECapability_None)

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"

Parameters

n	Name to use for policy object
vid	The VID value to check for
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4863 of file e32cmn.h.

_LIT_SECURITY_POLICY_V3

#define _LIT_SECURITY_POLICY_V3	(		n,
			vid,
			c1,
			c2,
			c3
	)		const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_V3(vid,c1,c2,c3)

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"

Parameters

n	Name to use for policy object
vid	The VID value to check for
c1	The first capability to check (enumerator of TCapability)
c2	The second capability to check (enumerator of TCapability)
c3	The third capability to check (enumerator of TCapability)

API status

Published to all clients. Released API.

Definition at line 4814 of file e32cmn.h.

_LIT_VENDOR_ID

#define _LIT_VENDOR_ID	(		name,
			value
	)		const SVendorId name={value}

Macro for compile-time definition of a vendor ID.

Parameters

name	Name to use for vendor ID
value	Value of vendor ID

API status

Published to all clients. Released API.

Definition at line 2172 of file e32cmn.h.

CAPABILITY_AS_TUINT8

#define CAPABILITY_AS_TUINT8

(

cap

)

Value:

    ((TUint8)(int)(                                                         \
        (cap)==ECapability_None                                             \
        ? (__invalid_capability_value(*)[1])(ECapability_None)                              \
        : (__invalid_capability_value(*)[((TUint)(cap+1)<=(TUint)ECapability_Limit)?1:2])(cap)  \
    ))

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"

Parameters

cap	The capability value

API status

Internal component API.

Definition at line 4076 of file e32cmn.h.

FOUR_TUINT8

#define FOUR_TUINT8	(		i1,
			i2,
			i3,
			i4
	)

Value:

    (                                     \
        (TUint32)((i1) & 0xFF)          | \
        (TUint32)((i2) & 0xFF) << 8     | \
        (TUint32)((i3) & 0xFF) << 16    | \
        (TUint32)((i4) & 0xFF) << 24      \
    )

A macro to construct a TUint32 from four TUint8s.

The TUint32 is in BigEndian ordering useful for class layout rather than number generation.

Parameters

i1	The first TUint8
i2	The second TUint8
i3	The third TUint8
i4	The fourth TUint8

API status

Internal component API.

Definition at line 4096 of file e32cmn.h.

KMaxSerialNumLength

#define KMaxSerialNumLength   64

Definition at line 5218 of file e32cmn.h.

KNullUid

#define KNullUid   TUid::Null()

Defines a null UID.

API status

Published to all clients. Released API.

Definition at line 1945 of file e32cmn.h.

TRAP

#define TRAP	(		_r,
			_s
	)		{TTrap __t;if (__t.Trap(_r)==0){_s;TTrap::UnTrap();}}

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.

Parameters

_r	An lvalue, convertible to TInt&, which will receive the result of any User::Leave() executed within _s or, if no leave occurred, it will be set to KErrNone. The value of _r on entry is not used.
_s	C++ statements which will be executed under a trap harness.

See also

TRAPD

API status

Published to all clients. Released API.

Definition at line 6237 of file e32cmn.h.

TRAP_IGNORE

#define TRAP_IGNORE

(

_s

)

{TInt _ignore;TTrap __t;if (__t.Trap(_ignore)==0){_s;TTrap::UnTrap();}}

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.

Parameters

_s	C++ statements which will be executed under a trap harness.

See also

TRAPD

TRAP

API status

Published to all clients. Released API.

Definition at line 6300 of file e32cmn.h.

TRAPD

#define TRAPD	(		_r,
			_s
	)		TInt _r;{TTrap __t;if (__t.Trap(_r)==0){_s;TTrap::UnTrap();}}

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.

Parameters

_r	A name, which will be declared as a TInt, and will receive the result of any User::Leave() executed within _s or, if no leave occurred, it will be set to KErrNone. After the macro, _r remains in scope until the end of its enclosing block.
_s	C++ statements which will be executed under a trap harness.

See also

TRAP

API status

Published to all clients. Released API.

Definition at line 6260 of file e32cmn.h.

Typedef Documentation

__NullPMF

typedef void(OnlyCreateWithNull::* __NullPMF) ()

API status

Internal technology API.

Definition at line 3177 of file e32cmn.h.

__TRefDesC

typedef TRefByValue<const TDesC> __TRefDesC

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

See also

TRefByValue

API status

Published to all clients. Released API.

Definition at line 1604 of file e32cmn.h.

HBufC

typedef HBufC8 HBufC

Defines a build-independent heap descriptor.

An 8-bit build variant is generated for a non-Unicode, non-kernel mode build.

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

See also

HBufC8

HBufC16

API status

Published to all clients. Released API.

Definition at line 1431 of file e32cmn.h.

RBuf

typedef RBuf8 RBuf

Defines a build-independent resizable buffer descriptor.

An 8-bit build variant is generated for a non-Unicode, non-kernel mode build.

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

See also

RBuf8

RBuf16

API status

Published to all clients. Released API.

Definition at line 1472 of file e32cmn.h.

TBufCBase

typedef TBufCBase8 TBufCBase

Definition at line 1481 of file e32cmn.h.

TDes

typedef TDes8 TDes

Defines a build-independent modifiable descriptor.

An 8-bit build variant is generated for a non-Unicode build.

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

See also

TDes8

TDes16

API status

Published to all clients. Released API.

Definition at line 1387 of file e32cmn.h.

TDesC

typedef TDesC8 TDesC

Defines a build-independent non-modifiable descriptor.

An 8-bit build variant is generated for a non-Unicode build.

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

See also

TDesC8

TDesC16

API status

Published to all clients. Released API.

Definition at line 1345 of file e32cmn.h.

TDesOverflow

typedef TDes8Overflow TDesOverflow

Defines a build-independent descriptor overflow handler.

An 8-bit build variant is generated for a non-Unicode, non-kernel mode build.

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

See also

TDes8Overflow

TDes16Overflow

API status

Published to all clients. Released API.

Definition at line 1453 of file e32cmn.h.

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

API status

Published to all clients. Released API.

Definition at line 1864 of file e32cmn.h.

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

API status

Published to all clients. Released API.

Definition at line 1880 of file e32cmn.h.

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

API status

Published to all clients. Released API.

Definition at line 1847 of file e32cmn.h.

TGeneralIdentityRelation

typedef TBool(* TGeneralIdentityRelation) (const TAny *, const TAny *)

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

API status

Published to all clients. Released API.

Definition at line 5386 of file e32cmn.h.

TGeneralLinearOrder

typedef TInt(* TGeneralLinearOrder) (const TAny *, const TAny *)

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

API status

Published to all clients. Released API.

Definition at line 5404 of file e32cmn.h.

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

API status

Published to all clients. Released API.

Definition at line 3544 of file e32cmn.h.

TMediaSerialNumber

typedef TBuf8<KMaxSerialNumLength> TMediaSerialNumber

Definition at line 5219 of file e32cmn.h.

TModuleMemoryInfo

typedef TProcessMemoryInfo TModuleMemoryInfo

Defines a more useful synonym for TProcessMemoryInfo.

API status

Published to all clients. Released API.

Definition at line 5295 of file e32cmn.h.

TName

typedef TBuf<KMaxName> TName

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

See also

TBuf

CObject

API status

Published to all clients. Released API.

Definition at line 1832 of file e32cmn.h.

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

API status

Published to all clients. Released API.

Definition at line 1896 of file e32cmn.h.

TPtr

typedef TPtr8 TPtr

Defines a build-independent modifiable pointer descriptor.

An 8-bit build variant is generated for a non-Unicode build.

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

See also

TPtr8

TPtr16

API status

Published to all clients. Released API.

Definition at line 1408 of file e32cmn.h.

TPtrC

typedef TPtrC8 TPtrC

Defines a build-independent non-modifiable pointer descriptor.

An 8-bit build variant is generated for a non-Unicode build.

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

See also

TPtrC8

TPtrC16

API status

Published to all clients. Released API.

Definition at line 1366 of file e32cmn.h.

TSecurityPolicyBuf

typedef TPckgBuf<TSecurityPolicy> TSecurityPolicyBuf

Provides a TPkcgBuf wrapper for a descriptorised TSecurityPolicy.

This a suitable container for passing a security policy across IPC.

API status

Published to all clients. Released API.

Definition at line 3955 of file e32cmn.h.

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

API status

Published to all clients. Released API.

Definition at line 1932 of file e32cmn.h.

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

API status

Published to all clients. Released API.

Definition at line 1915 of file e32cmn.h.

Enumeration Type Documentation

__invalid_capability_value

enum __invalid_capability_value

A dummy enum for use by the CAPABILITY_AS_TUINT8 macro.

API status

Internal component API.

Definition at line 4062 of file e32cmn.h.

TArrayFindMode

enum TArrayFindMode

Enumerator
EArrayFindMode_Any	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_First	Indicates that the first element in a block of duplicate elements is returned.
EArrayFindMode_Last	Indicates that the first element after the last element in a block of duplicate elements is returned.
EArrayFindMode_Limit	API status Internal technology API.

Definition at line 5517 of file e32cmn.h.

Function Documentation

_LIT()

_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.

API status

Published to all clients. Released API.

_LIT16()

_LIT16	(	KNullDesC16	,
		""
	)

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

API status

Published to all clients. Released API.

_LIT8()

_LIT8	(	KNullDesC8	,
		""
	)

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

API status

Published to all clients. Released API.

Abs()

template<class T >

T Abs ( T  aVal )

inline

Returns an absolute value.

Parameters

aVal	The source value.

Returns

The absolute value

API status

Published to all clients. Released API.

Definition at line 316 of file e32cmn.h.

Align2()

template<class T >

T Align2 ( T  aValue )

inline

Aligns the specified value onto a 2-byte boundary.

Parameters

aValue

The value to be aligned.

Returns

The aligned value.

API status

Published to all clients. Released API.

Definition at line 396 of file e32cmn.h.

Align4()

template<class T >

T Align4 ( T  aValue )

inline

Aligns the specified value onto a 4-byte boundary.

Parameters

aValue

The value to be aligned.

Returns

The aligned value.

API status

Published to all clients. Released API.

Definition at line 415 of file e32cmn.h.

Lim()

TInt Lim ( TInt  aVal, TUint  aLimit  )

inline

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

Parameters

aVal	The value to be tested.
aLimit	The upper limit.

Returns

True, if the value is less than or equal to the specified upper limit; false, otherwise.

API status

Published to all clients. Released API.

Definition at line 194 of file e32cmn.h.

LimX()

TInt LimX ( TInt  aVal, TUint  aLimit  )

inline

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

Parameters

aVal	The value to be tested.
aLimit	The upper limit.

Returns

True, if the value is strictly less than the specified upper limit; false, otherwise.

API status

Published to all clients. Released API.

Definition at line 215 of file e32cmn.h.

Max() [1/2]

template<class T >

T Max ( T  aLeft, T  aRight  )

inline

Returns the larger of two values.

Parameters

aLeft	The first value to be compared.
aRight	The second value to be compared.

Returns

The larger value.

API status

Published to all clients. Released API.

Definition at line 276 of file e32cmn.h.

Max() [2/2]

template<class T >

T Max ( T  aLeft, TUint  aRight  )

inline

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

Parameters

aLeft	The first value to be compared.
aRight	The second value to be compared.

Returns

The larger value.

API status

Published to all clients. Released API.

Definition at line 297 of file e32cmn.h.

memclr()

IMPORT_C TAny * memclr	(	TAny *	aTrg,
		unsigned int	aLength
	)

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

Parameters

aTrg	The start address.
aLength	The number of bytes to be set.

Returns

The target address.

API status

Published to all clients. Released API.

memcompare()

IMPORT_C TInt memcompare	(	const TUint8 *	aLeft,
		TInt	aLeftLen,
		const TUint8 *	aRight,
		TInt	aRightLen
	)

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

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

Parameters

aLeft	The start address of the first buffer in the comparison.
aLeftLen	The length of the first buffer in the comparison.
aRight	The start address of the second buffer in the comparison.
aRightLen	The length of the second buffer in the comparison.

Returns

Zero if both buffers are equal; non-zero, otherwise.

Panic condition: USER 88 In debug mode only, if aLeftL is negative, and the function is called on the user side. Panic condition: KERN-COMMON 88 In debug mode only, if aLeftL is negative, and the function is called on the kernel side. Panic condition: USER 89 In debug mode only, if aRightL is negative, and the function is called on the user side. Panic condition: KERN-COMMON 89 In debug mode only, if aRightL is negative, and the function is called on the kernel side.

API status

Published to all clients. Released API.

memcpy()

IMPORT_C TAny * memcpy	(	TAny *	aTrg,
		const TAny *	aSrc,
		unsigned int	aLength
	)

A Nanokernel utility function that copies bytes in memory.

Parameters

aTrg	The target address.
aSrc	The source address.
aLength	The number of bytes to be moved.

Returns

The target address.

API status

Published to all clients. Released API.

memmove()

IMPORT_C TAny * memmove	(	TAny *	aTrg,
		const TAny *	aSrc,
		unsigned int	aLength
	)

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

Parameters

aTrg	The target address.
aSrc	The source address.
aLength	The number of bytes to be moved.

Returns

The target address.

API status

Published to all clients. Released API.

memset()

IMPORT_C TAny * memset	(	TAny *	aTrg,
		TInt	aValue,
		unsigned int	aLength
	)

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

Parameters

aTrg	The start address.
aValue	The fill value (the first or junior byte).
aLength	The number of bytes to be set.

Returns

The target address.

API status

Published to all clients. Released API.

Min() [1/2]

template<class T >

T Min ( T  aLeft, T  aRight  )

inline

Returns the smaller of two values.

Parameters

aLeft	The first value to be compared.
aRight	The second value to be compared.

Returns

The smaller value.

API status

Published to all clients. Released API.

Definition at line 235 of file e32cmn.h.

Min() [2/2]

template<class T >

T Min ( T  aLeft, TUint  aRight  )

inline

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

Parameters

aLeft	The first value to be compared.
aRight	The second value to be compared.

Returns

The smaller value.

API status

Published to all clients. Released API.

Definition at line 256 of file e32cmn.h.

operator delete() [1/2]

GLREF_C void operator delete

(

TAny *

aPtr

)

API status

Published to all clients. Released API.

operator delete() [2/2]

void operator delete ( TAny *  aPtr, TAny *  aBase  )

inline

API status

Published to all clients. Released API.

operator delete[]() [1/2]

GLREF_C void operator delete[]

(

TAny *

aPtr

)

API status

Published to all clients. Released API.

operator delete[]() [2/2]

void operator delete[] ( TAny *  aPtr, TAny *  aBase  )

inline

API status

Published to all clients. Released API.

operator new() [1/3]

GLREF_C TAny * operator new

(

TUint

aSize

)

API status

Published to all clients. Released API.

operator new() [2/3]

TAny * operator new ( TUint  aSize, TAny *  aBase  )

inline

API status

Published to all clients. Released API.

operator new() [3/3]

GLREF_C TAny * operator new	(	TUint	aSize,
		TUint	anExtraSize
	)

API status

Published to all clients. Released API.

operator new[]() [1/2]

GLREF_C TAny * operator new[]

(

TUint

aSize

)

API status

Published to all clients. Released API.

operator new[]() [2/2]

TAny * operator new[] ( TUint  aSize, TAny *  aBase  )

inline

API status

Published to all clients. Released API.

operator!=() [1/3]

TBool operator!= ( RMessagePtr2  aLeft, RMessagePtr2  aRight  )

inline

operator!=() [2/3]

TBool operator!=	(	TTrue	,
		volatile const	TBool
	)

API status

Published to all clients. Released API.

operator!=() [3/3]

TBool operator!=	(	volatile const	TBool,
		TTrue
	)

API status

Published to all clients. Released API.

operator==() [1/3]

TBool operator== ( RMessagePtr2  aLeft, RMessagePtr2  aRight  )

inline

operator==() [2/3]

TBool operator==	(	TTrue	,
		volatile const	TBool
	)

API status

Published to all clients. Released API.

operator==() [3/3]

TBool operator==	(	volatile const	TBool,
		TTrue
	)

API status

Published to all clients. Released API.

PtrAdd()

template<class T , class S >

T * PtrAdd ( T *  aPtr, S  aVal  )

inline

Adds a value to a pointer.

Parameters

aPtr	Pointer to an object of type T.
aVal	The value to be added.

Returns

The resulting pointer value, as a pointer to a type T.

API status

Published to all clients. Released API.

Definition at line 357 of file e32cmn.h.

PtrSub()

template<class T , class S >

T * PtrSub ( T *  aPtr, S  aVal  )

inline

Subtracts a value from a pointer.

Parameters

aPtr	Pointer to an object of type T.
aVal	The value to be added.

Returns

The resulting pointer value, as a pointer to a type T.

API status

Published to all clients. Released API.

Definition at line 377 of file e32cmn.h.

Rng()

template<class T >

TBool Rng ( T  aMin, T  aVal, T  aMax  )

inline

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

Parameters

aMin	The lower value of the range.
aVal	The value to be compared.
aMax	The higher value of the range.

Returns

True, if the specified value lies within the range; false, otherwise.

API status

Published to all clients. Released API.

Definition at line 337 of file e32cmn.h.

wordmove()

IMPORT_C TAny * wordmove	(	TAny *	aTrg,
		const TAny *	aSrc,
		unsigned int	aLength
	)

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

aTrg	The target address.
aSrc	The source address.
aLength	The number of bytes to be moved.

Returns

The target address.

Panic condition: USER 91 In debug mode only, if aLength is not a multiple of 4, and the function is called on the user side. Panic condition: KERN-COMMON 91 In debug mode only, if aLength is not a multiple of 4, and the function is called on the kernel side. Panic condition: USER 92 In debug mode only, if aSrc is not aligned on a word boundary, and the function is called on the user side. Panic condition: KERN-COMMON 92 In debug mode only, if aSrc is not aligned on a word boundary, and the function is called on the kernel side. Panic condition: USER 93 In debug mode only, if aTrg is not aligned on a word boundary, and the function is called on the user side. Panic condition: KERN-COMMON 93 In debug mode only, if aTrg is not aligned on a word boundary, and the function is called on the kernel side.

API status

Published to all clients. Released API.

Variable Documentation

KCapabilitySetMaxSize

const TInt KCapabilitySetMaxSize = (((TInt)ECapability_HardLimit + 7)>>3)

Maximum size of capability set.

API status

Internal technology API.

Definition at line 3597 of file e32cmn.h.

KMaxSecurityPolicySize

const TInt KMaxSecurityPolicySize = KCapabilitySetMaxSize + 3*sizeof(TUint32)

Maximum size of any future extension to TSecurityPolicy.

API status

Internal technology API.

Definition at line 3604 of file e32cmn.h.

KScFlagBufOffsetListInUse

const TUint KScFlagBufOffsetListInUse =0x00000001

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.

API status

Published to platform partners. Prototype:

Definition at line 3556 of file e32cmn.h.

KScFlagUseGuardPages

const TUint KScFlagUseGuardPages =0x00000002

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.

API status

Published to platform partners. Prototype:

Definition at line 3566 of file e32cmn.h.