Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <e32cmn.h>
Link against: euser.lib

KNullUid

KNullUid TUid::Null()

Description

Defines a null UID

[Top]


_LIT_SECURE_ID

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

Description

Macro for compile-time definition of a secure ID

Parameters

name

Name to use for secure ID

value

Value of secure ID

[Top]


_LIT_VENDOR_ID

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

Description

Macro for compile-time definition of a vendor ID

Parameters

name

Name to use for vendor ID

value

Value of vendor ID

[Top]


_INIT_SECURITY_POLICY_FAIL

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& may be effected by using the function call operator n().

[Top]


_LIT_SECURITY_POLICY_FAIL

_LIT_SECURITY_POLICY_FAIL (n) const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_FAIL

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& may be effected by using the function call operator n().

Parameters

n

Name to use for policy object

[Top]


_INIT_SECURITY_POLICY_PASS

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& may be effected by using the function call operator n().

[Top]


_LIT_SECURITY_POLICY_PASS

_LIT_SECURITY_POLICY_PASS (n) const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_PASS

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& may be effected by using the function call operator n().

Parameters

n

Name to use for policy object

[Top]


_INIT_SECURITY_POLICY_C7

_INIT_SECURITY_POLICY_C7 (c1, c2, c3, c4, c5, c6, c7) {                                                                         \
    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)                                            \
    )                                                                       \
    }

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_C7

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_C6

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_C6

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_C5

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_C5

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_C4

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_C4

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_C3

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_C3

_LIT_SECURITY_POLICY_C3 (n, c1, c2, c3) const TStaticSecurityPolicy n = _INIT_SECURITY_POLICY_C3(c1,c2,c3)

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_C2

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_C2

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_C1

_INIT_SECURITY_POLICY_C1 (c1) _INIT_SECURITY_POLICY_C3(c1,ECapability_None,ECapability_None)

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_C1

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_S3

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_S3

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_S2

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_S2

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_S1

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_S1

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_S0

_INIT_SECURITY_POLICY_S0 (sid) _INIT_SECURITY_POLICY_S3(sid,ECapability_None,ECapability_None,ECapability_None)

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& may be effected by using the function call operator n().

Parameters

sid

The SID value to check for

[Top]


_LIT_SECURITY_POLICY_S0

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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

[Top]


_INIT_SECURITY_POLICY_V3

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_V3

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_V2

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_V2

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_V1

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_LIT_SECURITY_POLICY_V1

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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)

[Top]


_INIT_SECURITY_POLICY_V0

_INIT_SECURITY_POLICY_V0 (vid) _INIT_SECURITY_POLICY_V3(vid,ECapability_None,ECapability_None,ECapability_None)

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& may be effected by using the function call operator n().

Parameters

vid

The VID value to check for

[Top]


_LIT_SECURITY_POLICY_V0

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

Description

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 TSecurityPolicyTSecurityPolicy&. Taking the address of the object will return a const TSecurityPolicy*. Explicit conversion to const TSecurityPolicyTSecurityPolicy& 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

[Top]


TRAP

TRAP (_r, _s) {                                                     \
    TInt& __rref = _r;                                      \
    __rref = 0;                                             \
    { TRAP_INSTRUMENTATION_START; }                         \
    try {                                                  \
        __WIN32SEHTRAP                                      \
        TTrapHandler* ____t = User::MarkCleanupStack();     \
        _s;                                                 \
        User::UnMarkCleanupStack(____t);                    \
        { TRAP_INSTRUMENTATION_NOLEAVE; }                   \
        __WIN32SEHUNTRAP                                    \
        }                                                   \
    catch (XLeaveException& l)                              \
        {                                                   \
        __rref = l.GetReason();                             \
        { TRAP_INSTRUMENTATION_LEAVE(__rref); }             \
        }                                                   \
    catch (...)                                             \
        {                                                   \
        User::Invariant();                                  \
        }                                                   \
    __CALL_EMPTY_FUNCTION                                   \
    { TRAP_INSTRUMENTATION_END; }                           \
    }

Description

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

[Top]


TRAPD

TRAPD (_r, _s) TInt _r;                                             \
    {                                                       \
    _r = 0;                                                 \
    { TRAP_INSTRUMENTATION_START; }                         \
    try {                                                  \
        __WIN32SEHTRAP                                      \
        TTrapHandler* ____t = User::MarkCleanupStack();     \
        _s;                                                 \
        User::UnMarkCleanupStack(____t);                    \
        { TRAP_INSTRUMENTATION_NOLEAVE; }                   \
        __WIN32SEHUNTRAP                                    \
        }                                                   \
    catch (XLeaveException& l)                              \
        {                                                   \
        _r = l.GetReason();                                 \
        { TRAP_INSTRUMENTATION_LEAVE(_r); }                 \
        }                                                   \
    catch (...)                                             \
        {                                                   \
        User::Invariant();                                  \
        }                                                   \
    __CALL_EMPTY_FUNCTION                                   \
    { TRAP_INSTRUMENTATION_END; }                           \
    }

Description

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

[Top]


TRAP_IGNORE

TRAP_IGNORE (_s) {                                                      \
    { TRAP_INSTRUMENTATION_START; }                         \
    try {                                                  \
        __WIN32SEHTRAP                                      \
        TTrapHandler* ____t = User::MarkCleanupStack();     \
        _s;                                                 \
        User::UnMarkCleanupStack(____t);                    \
        { TRAP_INSTRUMENTATION_NOLEAVE; }                   \
        __WIN32SEHUNTRAP                                    \
        }                                                   \
    catch (XLeaveException& l)                              \
        {                                                   \
        l.GetReason();                                      \
        { TRAP_INSTRUMENTATION_LEAVE(l.Reason()); }         \
        }                                                   \
    catch (...)                                             \
        {                                                   \
        User::Invariant();                                  \
        }                                                   \
    __CALL_EMPTY_FUNCTION                                   \
    { TRAP_INSTRUMENTATION_END; }                           \
    }

Description

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.

Use this macro as a C++ statement.

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

[Top]


Typedef TDesC

typedef TDesC16 TDesC;

Description

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.

[Top]


Typedef TPtrC

typedef TPtrC16 TPtrC;

Description

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.

[Top]


Typedef TDes

typedef TDes16 TDes;

Description

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.

[Top]


Typedef TPtr

typedef TPtr16 TPtr;

Description

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.

[Top]


Typedef HBufC

typedef HBufC16 HBufC;

Description

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.

[Top]


Typedef TDesOverflow

typedef TDes16Overflow TDesOverflow;

Description

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.

[Top]


Typedef RBuf

typedef RBuf16 RBuf;

Description

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.

[Top]


Typedef __TRefDesC

typedef TRefByValue<const TDesC> __TRefDesC;

Description

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

See also:

[Top]


Typedef TName

typedef TBuf<KMaxName> TName;

Description

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

See also:

[Top]


Typedef TFullName

typedef TBuf<KMaxFullName> TFullName;

Description

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

See also:

[Top]


Typedef TExitCategoryName

typedef TBuf<KMaxExitCategoryName> TExitCategoryName;

Description

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:

[Top]


Typedef TFileName

typedef TBuf<KMaxFileName> TFileName;

Description

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

[Top]


Typedef TPath

typedef TBuf<KMaxPath> TPath;

Description

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

[Top]


Typedef TVersionName

typedef TBuf<KMaxVersionName> TVersionName;

Description

Version name type.

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

[Top]


Typedef TUidName

typedef TBuf<KMaxUidName> TUidName;

Description

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

See also:

[Top]


Typedef TMediaPassword

typedef TBuf8<KMaxMediaPassword> TMediaPassword;

Description

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.

[Top]


Typedef TSecurityPolicyBuf

typedef TPckgBuf<TSecurityPolicy> TSecurityPolicyBuf;

Description

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

[Top]


Typedef TModuleMemoryInfo

typedef TProcessMemoryInfo TModuleMemoryInfo;

Description

Defines a more useful synonym for TProcessMemoryInfoTProcessMemoryInfo.

[Top]


Typedef TGeneralIdentityRelation

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

Description

Defines a function type used by a TIdentityRelationTIdentityRelation object.

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

See also:

[Top]


Typedef TGeneralLinearOrder

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

Description

Defines a function type used by a TLinearOrderTLinearOrder object

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

See also:

[Top]


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

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

Description

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

const TUint8TUint8 *aLeft

The start address of the first buffer in the comparison.

TIntTInt aLeftLen

The length of the first buffer in the comparison.

const TUint8TUint8 *aRight

The start address of the second buffer in the comparison.

TIntTInt aRightLen

The length of the second buffer in the comparison.

Return value

TIntTInt

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

Panic codes

USER

88 In debug mode only, if aLeftL is negative, and the function is called on the user side.

KERN-COMMON

88 In debug mode only, if aLeftL is negative, and the function is called on the kernel side.

USER

89 In debug mode only, if aRightL is negative, and the function is called on the user side.

KERN-COMMON

89 In debug mode only, if aRightL is negative, and the function is called on the kernel side.

[Top]


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

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

Description

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

TAnyTAny *aTrg

The target address.

const TAnyTAny *aSrc

The source address.

unsigned int aLength

The number of bytes to be moved.

Return value

TAnyTAny *

The target address.

Panic codes

USER

91 In debug mode only, if aLength is not a multiple of 4, and the function is called on the user side.

KERN-COMMON

91 In debug mode only, if aLength is not a multiple of 4, and the function is called on the kernel side.

USER

92 In debug mode only, if aSrc is not aligned on a word boundary, and the function is called on the user side.

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.

USER

93 In debug mode only, if aTrg is not aligned on a word boundary, and the function is called on the user side.

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.

[Top]


memclr(TAny *,unsigned int)

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

Description

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

Parameters

TAnyTAny *aTrg

The start address.

unsigned int aLength

The number of bytes to be set.

Return value

TAnyTAny *

The target address.

[Top]


memset(TAny *,TInt,unsigned int)

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

Description

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

Parameters

TAnyTAny *aTrg

The start address.

TIntTInt aValue

The fill value (the first or junior byte).

unsigned int aLength

The number of bytes to be set.

Return value

TAnyTAny *

The target address.

[Top]


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

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

Description

A Nanokernel utility function that copies bytes in memory.

Parameters

TAnyTAny *aTrg

The target address.

const TAnyTAny *aSrc

The source address.

unsigned int aLength

The number of bytes to be moved.

Return value

TAnyTAny *

The target address.

[Top]


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

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

Description

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

Parameters

TAnyTAny *aTrg

The target address.

const TAnyTAny *aSrc

The source address.

unsigned int aLength

The number of bytes to be moved.

Return value

TAnyTAny *

The target address.

[Top]


Lim(TInt,TUint)

inline TInt Lim(TInt aVal, TUint aLimit);

Description

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

Parameters

TIntTInt aVal

The value to be tested.

TUintTUint aLimit

The upper limit.

Return value

TIntTInt

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

[Top]


LimX(TInt,TUint)

inline TInt LimX(TInt aVal, TUint aLimit);

Description

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

Parameters

TIntTInt aVal

The value to be tested.

TUintTUint aLimit

The upper limit.

Return value

TIntTInt

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

[Top]


Min(T,T)

inline T Min(T aLeft, T aRight);

Description

Returns the smaller of two values.

Parameters

T aLeft

The first value to be compared.

T aRight

The second value to be compared.

Return value

T

The smaller value.

[Top]


Min(T,TUint)

inline T Min(T aLeft, TUint aRight);

Description

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

Parameters

T aLeft

The first value to be compared.

TUintTUint aRight

The second value to be compared.

Return value

T

The smaller value.

[Top]


Max(T,T)

inline T Max(T aLeft, T aRight);

Description

Returns the larger of two values.

Parameters

T aLeft

The first value to be compared.

T aRight

The second value to be compared.

Return value

T

The larger value.

[Top]


Max(T,TUint)

inline T Max(T aLeft, TUint aRight);

Description

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

Parameters

T aLeft

The first value to be compared.

TUintTUint aRight

The second value to be compared.

Return value

T

The larger value.

[Top]


Abs(T)

inline T Abs(T aVal);

Description

Returns an absolute value.

Parameters

T aVal

The source value.

Return value

T

The absolute value

[Top]


Rng(T,T,T)

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

Description

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

Parameters

T aMin

The lower value of the range.

T aVal

The value to be compared.

T aMax

The higher value of the range.

Return value

TBoolTBool

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

[Top]


PtrAdd(T *,S)

inline T* PtrAdd(T *aPtr, S aVal);

Description

Adds a value to a pointer.

Parameters

T *aPtr

Pointer to an object of type T.

S aVal

The value to be added.

Return value

T *

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

[Top]


PtrSub(T *,S)

inline T* PtrSub(T *aPtr, S aVal);

Description

Subtracts a value from a pointer.

Parameters

T *aPtr

Pointer to an object of type T.

S aVal

The value to be added.

Return value

T *

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

[Top]


Align2(T)

inline T Align2(T aValue);

Description

Aligns the specified value onto a 2-byte boundary.

Parameters

T aValue

The value to be aligned.

Return value

T

The aligned value.

[Top]


Align4(T)

inline T Align4(T aValue);

Description

Aligns the specified value onto a 4-byte boundary.

Parameters

T aValue

The value to be aligned.

Return value

T

The aligned value.


e32cmn.h Global variables

[Top]


KNullDesC

const TLitC< sizeof(L"")/2 KNullDesC)={sizeof(L"" )/2-1,L"" };

Description

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.

[Top]


KNullDesC8

const TLitC8< sizeof("") KNullDesC8)={sizeof( "" )-1, "" };

Description

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

[Top]


KNullDesC16

const TLitC16< sizeof(L"")/2 KNullDesC16)={sizeof(L"" )/2-1,L"" };

Description

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