Class TCheckedUid

class TCheckedUid;

Description

Packages a Uid type together with a checksum.

Members

Defined in TCheckedUid:
Check(), Des(), Set(), Set(), TCheckedUid(), TCheckedUid(), TCheckedUid(), UidType()

See also:

• TUidType

IMPORT_C TCheckedUid();

Description

Default constructor.

Initialises the object to binary zeroes.

IMPORT_C TCheckedUid(const TUidType &aUidType);

Description

Constructor taking an existing Uid type.

The constructor calculates a checksum.

Parameters

const TUidType &aUidType The Uid type to be packaged.

IMPORT_C TCheckedUid(const TDesC8 &aPtr);

Description

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

const TDesC8 &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 TCheckedUid object.

IMPORT_C void Set(const TUidType &aUidType);

Description

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

Parameters

const TUidType &aUidType The Uid type to be packaged.

IMPORT_C void Set(const TDesC8 &aPtr);

Description

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

const TDesC8 &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 TCheckedUid object.

IMPORT_C TPtrC8 Des() const;

Description

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

Return value

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

inline const TUidType &UidType() const;

Description

Gets the Uid type contained in this object.

Return value

const TUidType & The Uid type.

protected: IMPORT_C TUint Check() const;

Description

Calculates the checksum of the UIDs.

Return value

TUint The checksum.