Collapse all Symbian^3 Product Developer Library

TCheckedUid Class Reference

class TCheckedUid

Packages a Uid type together with a checksum.

Public Member Functions
	TCheckedUid()
	TCheckedUid(const TUidType &)
	TCheckedUid(const TDesC8 &)
IMPORT_C TPtrC8	Des()
IMPORT_C void	Set(const TUidType &)
IMPORT_C void	Set(const TDesC8 &)
const TUidType &	UidType()

Protected Member Functions
IMPORT_C TUint	Check()

Private Attributes
TUint	iCheck
TUidType	iType

Constructor & Destructor Documentation

TCheckedUid()

IMPORT_C

TCheckedUid

(

)

Default constructor.

Initialises the object to binary zeroes.

TCheckedUid(const TUidType &)

IMPORT_C

TCheckedUid

(

const TUidType &

aUidType

)

Constructor taking an existing Uid type.

The constructor calculates a checksum.

Parameters

const TUidType & aUidType

The Uid type to be packaged.

TCheckedUid(const TDesC8 &)

IMPORT_C

TCheckedUid

(

const TDesC8 &

aPtr

)

Constructor taking an existing TCheckedUid object encapsulated within a descriptor.

The checksum is recalculated and must match the checksum value passed in the encapsulated TCheckedUid object, otherwise the content of this object is reset to binary zeroes.

panic: USER 38 If the length of the descriptor is not the same as the size of a TCheckedUid object.

Parameters

const TDesC8 & aPtr

A pointer to a descriptor containing an existing TCheckedUid object.

Member Functions Documentation

Check()

IMPORT_C TUint

Check

(

)

const [protected]

Calculates the checksum of the UIDs.

Des()

IMPORT_C TPtrC8

Des

(

)

const

Gets a pointer descriptor to represent this object's data.

Set(const TUidType &)

IMPORT_C void

Set

(

const TUidType &

aUidType

)

Sets the specified Uid type to be packaged, and recalculates the checksum.

Parameters

const TUidType & aUidType

The Uid type to be packaged.

Set(const TDesC8 &)

IMPORT_C void

Set

(

const TDesC8 &

aPtr

)

Sets an existing TCheckedUid object encapsulated within a descriptor.

The checksum is recalculated and must match the checksum value passed in the encapsulated TCheckedUid object, otherwise the content of this object is reset to binary zeroes.

panic: USER 38 If the length of the descriptor is not the same as the size of a TCheckedUid object.

Parameters

const TDesC8 & aPtr

A pointer to a descriptor containing an existing TCheckedUid object.

UidType()

const TUidType &

UidType

(

)

const [inline]

Gets the Uid type contained in this object.

Member Data Documentation

TUint iCheck

TUint

iCheck

[private]

TUidType iType

TUidType

iType

[private]