Class TUidType

TUidType

Support

Supported from 5.0

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.

Defined in TUidType:
IsPresent(), IsValid(), MostDerived(), TUidType(), operator!=(), operator==(), operator[]()

TUidType();

Description

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

TUidType(TUid aUid1);

Description

Creates a UID type and sets the UID1 component to a specified value. The UID2 and UID3 components are set to KNullUid.

Parameters

TUid aUid1 Value for UID1

TUidType(TUid aUid1,TUid aUid2);

Description

Creates a UID type and sets the UID1 and UID2 components to specified values. The UID3 component is set to KNullUid.

Parameters

TUid aUid1 Value for UID1 TUid aUid2 Value for UID2

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

Description

Creates a UID type and sets all three UID components to specified values.

Parameters

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

TInt operator==(const TUidType& aUidType) const;

Description

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

Parameters

TUidType& aUidType The UID type to be compared.

Return value

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

TInt operator!=(const TUidType& aUidType) const;

Description

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

Parameters

TUidType& aUidType The UID type to be compared.

Return value

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

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.

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.

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

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

Description

Returns 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, and 2 specifies UID3. The function raises a USER 37 panic if the value is outside this range.

Return value

TUid& A reference to the required UID component