Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

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

Class TUidType

class TUidType;

Description

Encapsulates a set of three unique identifiers (UIDs) which, in combination, identify a system object such as a GUI application or a DLL. The three component UIDs are referred to as UID1, UID2 and UID3.

An object of this type is referred to as a compound identifier or a UID type.

Members

Defined in TUidType:


Construction and destruction


TUidType()

IMPORT_C TUidType();

Description

Default constructor.

Creates a UID type, and sets all three component UIDs to KNullUid.


TUidType(TUid)

IMPORT_C TUidType(TUid aUid1);

Description

Constructor that creates a UID type and sets the UID1 component to the specified value.

The UID2 and UID3 components are set to KNullUid.

Parameters

TUid aUid1

Value for UID1.


TUidType(TUid,TUid)

IMPORT_C TUidType(TUid aUid1, TUid aUid2);

Description

Constructor that creates a UID type and sets the UID1 and UID2 components to the specified values.

The UID3 component is set to KNullUid.

Parameters

TUid aUid1

Value for UID1.

TUid aUid2

Value for UID2.


TUidType(TUid,TUid,TUid)

IMPORT_C TUidType(TUid aUid1, TUid aUid2, TUid aUid3);

Description

Constructor that creates a UID type and sets all three UID components to the specified values.

Parameters

TUid aUid1

Value for UID1.

TUid aUid2

Value for UID2.

TUid aUid3

Value for UID3.

[Top]


Member functions


operator==(const TUidType &)const

IMPORT_C TBool operator==(const TUidType &aUidType) const;

Description

Compares this UID type for equality with the specified UID type.

Parameters

const TUidType &aUidType

The UID type to be compared.

Return value

TBool

True, if each component UID is equal to the corresponding component UID in the specified UID type; false, otherwise.


operator!=(const TUidType &)const

IMPORT_C TBool operator!=(const TUidType &aUidType) const;

Description

Compares this UID type for inequality with the specified UID type.

Parameters

const TUidType &aUidType

The UID type to be compared.

Return value

TBool

True, if any component UID is not equal to the corresponding component UID in the specified UID type; false otherwise.


operator[](TInt)const

IMPORT_C const TUid& operator[](TInt anIndex) const;

Description

Gets the UID component as identified by the specified index.

Parameters

TInt anIndex

Index value indicating which UID component to return. 0 specifies UID1, 1 specifies UID2, 2 specifies UID3.

Return value

const TUid &

A reference to the required UID component.

Panic codes

USER

37 if aIndex is not in the range 0 to 2, inclusive.


MostDerived()const

IMPORT_C TUid MostDerived() const;

Description

Gets the most derived UID.

Taking the three UID components as a hierarchy with UID1 being the most general, UID2 being more specific than UID1 and UID3 being more specific than UID2, then the function returns:

UID3, if UID3 is not KNullUid.

UID2, if UID2 is not KNullUid.

UID1, otherwise

Return value

TUid

The most derived UID.


IsPresent(TUid)const

IMPORT_C TBool IsPresent(TUid aUid) const;

Description

Tests if any of the component UIDs are equal to the specified UID.

Parameters

TUid aUid

The UID to be tested.

Return value

TBool

True, if any one of the component UIDs are the same as the specified UID; false, if none of the component UIDs are the same.


IsValid()const

IMPORT_C TBool IsValid() const;

Description

Tests the object for a valid (non-KNullUid) UID type.

Return value

TBool

True, if at least one of the component UIDs is not KNullUid; false, if all component UIDs are KNullUid.