TUidType Class Reference

Encapsulates a set of three unique identifiers (UIDs) which, in combination, identify a system object such as a GUI application or a DLL. More...

#include <e32cmn.h>

Public Member Functions
IMPORT_C	TUidType ()
	Default constructor.
IMPORT_C	TUidType (TUid aUid1)
	Constructor that creates a UID type and sets the UID1 component to the specified value.
IMPORT_C	TUidType (TUid aUid1, TUid aUid2)
	Constructor that creates a UID type and sets the UID1 and UID2 components to the specified values.
IMPORT_C	TUidType (TUid aUid1, TUid aUid2, TUid aUid3)
	Constructor that creates a UID type and sets all three UID components to the specified values.
IMPORT_C TBool	operator== (const TUidType &aUidType) const
	Compares this UID type for equality with the specified UID type.
IMPORT_C TBool	operator!= (const TUidType &aUidType) const
	Compares this UID type for inequality with the specified UID type.
IMPORT_C const TUid &	operator[] (TInt anIndex) const
	Gets the UID component as identified by the specified index.
IMPORT_C TUid	MostDerived () const
	Gets the most derived UID.
IMPORT_C TBool	IsPresent (TUid aUid) const
	Tests if any of the component UIDs are equal to the specified UID.
IMPORT_C TBool	IsValid () const
	Tests the object for a valid (non-KNullUid) UID type.

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

API status

Published to all clients. Released API.

Definition at line 1990 of file e32cmn.h.

Constructor & Destructor Documentation

TUidType() [1/4]

IMPORT_C TUidType::TUidType

(

)

Default constructor.

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

(generated from Symbian Developer Library)

TUidType() [2/4]

IMPORT_C TUidType::TUidType

(

TUid

aUid1

)

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

aUid1

Value for UID1.

(generated from Symbian Developer Library)

TUidType() [3/4]

IMPORT_C TUidType::TUidType	(	TUid	aUid1,
		TUid	aUid2
	)

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

aUid1	Value for UID1.
aUid2	Value for UID2.

(generated from Symbian Developer Library)

TUidType() [4/4]

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

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

Parameters

aUid1	Value for UID1.
aUid2	Value for UID2.
aUid3	Value for UID3.

(generated from Symbian Developer Library)

Member Function Documentation

IsPresent()

IMPORT_C TBool TUidType::IsPresent

(

TUid

aUid

)

const

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

Parameters

aUid	The UID to be tested.

(generated from Symbian Developer Library)

IsValid()

IMPORT_C TBool TUidType::IsValid

(

)

const

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

KNullUid

(generated from Symbian Developer Library)

MostDerived()

IMPORT_C TUid TUidType::MostDerived

(

)

const

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

KNullUid

(generated from Symbian Developer Library)

operator!=()

IMPORT_C TBool TUidType::operator!=

(

const TUidType &

aUidType

)

const

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

Parameters

aUidType

The UID type to be compared.

(generated from Symbian Developer Library)

operator==()

IMPORT_C TBool TUidType::operator==

(

const TUidType &

aUidType

)

const

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

Parameters

aUidType

The UID type to be compared.

(generated from Symbian Developer Library)

operator[]()

IMPORT_C const TUid & TUidType::operator[]

(

TInt

anIndex

)

const

Gets the UID component as identified by the specified index.

Parameters

anIndex

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

Panic condition: USER 37 if aIndex is not in the range 0 to 2, inclusive.

(generated from Symbian Developer Library)

---

The documentation for this class was generated from the following files:

• e32cmn.h
• e32cmn.h.dox