TCheckedUid Class Reference

Packages a Uid type together with a checksum. More...

#include <e32std.h>

Public Member Functions
IMPORT_C	TCheckedUid ()
	Default constructor.
IMPORT_C	TCheckedUid (const TUidType &aUidType)
	Constructor taking an existing Uid type.
IMPORT_C	TCheckedUid (const TDesC8 &aPtr)
	Constructor taking an existing TCheckedUid object encapsulated within a descriptor.
IMPORT_C void	Set (const TUidType &aUidType)
	Sets the specified Uid type to be packaged, and recalculates the checksum.
IMPORT_C void	Set (const TDesC8 &aPtr)
	Sets an existing TCheckedUid object encapsulated within a descriptor.
IMPORT_C TPtrC8	Des () const
	Gets a pointer descriptor to represent this object's data.
const TUidType &	UidType () const
	Gets the Uid type contained in this object.

Protected Member Functions
IMPORT_C TUint	Check () const
	Calculates the checksum of the UIDs.

Detailed Description

Packages a Uid type together with a checksum.

See also

TUidType

API status

Published to all clients. Released API.

Definition at line 1516 of file e32std.h.

Constructor & Destructor Documentation

TCheckedUid() [1/3]

IMPORT_C TCheckedUid::TCheckedUid

(

)

Default constructor.

Initialises the object to binary zeroes.

(generated from Symbian Developer Library)

TCheckedUid() [2/3]

IMPORT_C TCheckedUid::TCheckedUid

(

const TUidType &

aUidType

)

Constructor taking an existing Uid type.

The constructor calculates a checksum.

Parameters

aUidType

The Uid type to be packaged.

(generated from Symbian Developer Library)

TCheckedUid() [3/3]

IMPORT_C TCheckedUid::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 condition: USER 38 If the length of the descriptor is not the same as the size of a TCheckedUid object.

(generated from Symbian Developer Library)

Member Function Documentation

Check()

IMPORT_C TUint TCheckedUid::Check ( ) const

protected

Calculates the checksum of the UIDs.

(generated from Symbian Developer Library)

Des()

IMPORT_C TPtrC8 TCheckedUid::Des

(

)

const

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

(generated from Symbian Developer Library)

Set() [1/2]

IMPORT_C void TCheckedUid::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 condition: USER 38 If the length of the descriptor is not the same as the size of a TCheckedUid object.

(generated from Symbian Developer Library)

Set() [2/2]

IMPORT_C void TCheckedUid::Set

(

const TUidType &

aUidType

)

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

Parameters

aUidType

The Uid type to be packaged.

(generated from Symbian Developer Library)

UidType()

const TUidType & TCheckedUid::UidType ( ) const

inline

Gets the Uid type contained in this object.

(generated from Symbian Developer Library)

---

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

• e32std.h
• e32std.h.dox