TCheckedUid Class Reference

#include <e32std.h>

class TCheckedUid

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

Detailed Description

Packages a Uid type together with a checksum.

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

Parameters
aPtr	A pointer to a descriptor containing an existing TCheckedUid object.

Panic Codes
USER	38 If the length of the descriptor is not the same as the size of a

Member Function Documentation

Check ( )

IMPORT_C TUint

Check

(

)

const [protected]

Calculates the checksum of the UIDs.

Return Value: The checksum.

Des ( )

IMPORT_C TPtrC8

Des

(

)

const

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

Return Value: The pointer descriptor for this object's data. The descriptor's length is the same as the length of a TCheckedUid object.

Set ( const TUidType & )

IMPORT_C void

Set

(

const TUidType &

aUidType

)

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

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

Parameters
aPtr	A pointer to a descriptor containing an existing TCheckedUid object.

Panic Codes
USER	38 If the length of the descriptor is not the same as the size of a

UidType ( )

const TUidType &

UidType

(

)

const [inline]

Gets the Uid type contained in this object.

Return Value: The Uid type.