Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: tz.h
Link against: tzclient.lib

Class CTzId

class CTzId : public CBase;

Description

Encapsulates a time zone identifier.

The identifier may be either a name or a number.

Derivation

Members

Defined in CTzId:
NewL(), NewL(), TimeZoneNameID(), TimeZoneNumericID(), operator!=(), operator==(), ~CTzId()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also


Construction and destruction


~CTzId()

IMPORT_C ~CTzId();

Description

Destructor.


NewL()

static IMPORT_C CTzId *NewL(TUint aNumericId);

Description

Time zone ID factory method.

Parameters

TUint aNumericId

A numeric reference ID, generated by the time zone compiler.

Return value

CTzId *

A pointer to the time zone ID. Clients take ownership.

Panic codes

TzServer

8 aNumericId must not be zero.


NewL()

static IMPORT_C CTzId *NewL(const TDesC8 &aNameIdentity);

Description

Time zone ID factory method.

Parameters

const TDesC8 &aNameIdentity

A name recognised by the time zone database.

Return value

CTzId *

A pointer to the time zone ID. Clients take ownership.

[Top]


Member functions


TimeZoneNameID()

IMPORT_C const TDesC8 &TimeZoneNameID() const;

Description

Retrieves the time zone's name. This can be used after calling RTz::GetTimeZoneIdL().

Return value

const TDesC8 &

The time zone's name, if one has been set. A NULL descriptor if not.


TimeZoneNumericID()

IMPORT_C TUint TimeZoneNumericID() const;

Description

Retrieves the time zone's numeric ID. This can be used after calling RTz::GetTimeZoneIdL().

Return value

TUint

The time zone's numeric ID, generated by the time zone compiler.


operator==()

IMPORT_C TBool operator==(const CTzId &aTZId) const;

Description

Equality operator.

Parameters

const CTzId &aTZId

The ID of another time zone.

Return value

TBool

True if the specified time zone ID is the same as this one, otherwise false.


operator!=()

inline TBool operator!=(const CTzId &aTZId) const;

Description

Inequality operator.

Parameters

const CTzId &aTZId

The time zone ID to compare with this one.

Return value

TBool

True if the two IDs are different. False if they are the same.