CTzId Class Reference

#include <tzid.h>

Link against: tzclient.lib

class CTzId : public CBase

Inherits from

Public Member Functions
~CTzId()
IMPORT_C CTzId *CloneL()
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TBoolIsUserTzId()
IMPORT_C TBoolIsUserTzId(TUint)
IMPORT_C CTzId *NewL(TUint)
IMPORT_C CTzId *NewL(const TDesC8 &)
IMPORT_C CTzId *NewL(RReadStream &)
IMPORT_C voidSetId(TUint)
IMPORT_C voidSetIdL(const TDesC8 &)
voidSetIdL(TUint, const TDesC8 &)
IMPORT_C const TDesC8 &TimeZoneNameID()
IMPORT_C TUintTimeZoneNumericID()
TBool operator!=(const CTzId &)
IMPORT_C TBooloperator==(const CTzId &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()

Detailed Description

Encapsulates a time zone identifier.

The identifier may be either a name or a number.

Since
9.1

Constructor & Destructor Documentation

~CTzId ( )

IMPORT_C~CTzId()

Destructor.

Member Function Documentation

CloneL ( )

IMPORT_C CTzId *CloneL()const

This should not be used. For internal use only.

Replicates a CTzId.

Return Value
A pointer to CTzId; clients own the object.
Leave Codes
KErrNoMemoryor some other system error code.

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

This should not be used. For internal use only.

Time zone ID data externaliser.

Parameters
aStreamA stream that will contain the serialised time zone ID.

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

This should not be used. For internal use only.

Serialised CTzId data internaliser.

Parameters
aStreama stream containing the serialised time zone Id

IsUserTzId ( )

IMPORT_C TBoolIsUserTzId()const

Determines if this time zone identifier has a numeric identifier value that belongs to the range of values used to identify user-defined time zones.

Return Value
Returns ETrue if this time zone identifier has a numeric identifier value that belongs to the range of values used to identify user-defined time zones and EFalse otherwise.

IsUserTzId ( TUint )

IMPORT_C TBoolIsUserTzId(TUintaTzId)[static]

Determines if the given numeric time zone identifier value belongs to the range of values used to identify user-defined time zones.

Parameters
aTzIdNumeric time zone identifier value.
Return Value
Returns ETrue if the given numeric time zone identifier value belongs to the range of values used to identify user-defined time zones and EFalse otherwise.

NewL ( TUint )

IMPORT_C CTzId *NewL(TUintaNumericId)[static]

Time zone ID factory method.

Parameters
aNumericIdA numeric reference ID, generated by the time zone compiler.
Return Value
A pointer to the time zone ID. Clients take ownership.
Panic Codes
TzServer8 aNumericId must not be zero.

NewL ( const TDesC8 & )

IMPORT_C CTzId *NewL(const TDesC8 &aNameIdentity)[static]

Time zone ID factory method.

Parameters
aNameIdentityA name recognised by the time zone database.
Return Value
A pointer to the time zone ID. Clients take ownership.

NewL ( RReadStream & )

IMPORT_C CTzId *NewL(RReadStream &aStream)[static]

This should not be used. For internal use only.

Time zone ID factory method.

Parameters
aStreama stream containing the serialised time zone Id
Return Value
Pointer to CTzId; clients own the object.
Leave Codes
KErrNoMemoryor some other system error code

SetId ( TUint )

IMPORT_C voidSetId(TUintaNumericId)

This should not be used. For internal use only.

Sets the numeric time zone ID.

Parameters
aNumericIdThe new numeric ID, generated by the time zone compiler.

SetIdL ( const TDesC8 & )

IMPORT_C voidSetIdL(const TDesC8 &aNameIdentity)

This should not be used. For internal use only.

Sets the the time zone's name.

Parameters
aNameIdentitystring TZID as used in the Olson's TZ Database

SetIdL ( TUint, const TDesC8 & )

voidSetIdL(TUintaNumRefId,
const TDesC8 &aZoneIdentity
)

TimeZoneNameID ( )

IMPORT_C const TDesC8 &TimeZoneNameID()const

Retrieves the time zone's name.

This can be used after calling RTz::GetTimeZoneIdL().

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

TimeZoneNumericID ( )

IMPORT_C TUintTimeZoneNumericID()const

Retrieves the time zone's numeric ID.

This can be used after calling RTz::GetTimeZoneIdL().

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

operator!= ( const CTzId & )

TBool operator!=(const CTzId &aTZId)const [inline]

Inequality operator.

Parameters
aTZIdThe time zone ID to compare with this one.
Return Value
ETrue if the two IDs are different, EFalse if they are the same.

operator== ( const CTzId & )

IMPORT_C TBooloperator==(const CTzId &aTZId)const

Equality operator.

Parameters
aTZIdThe ID of another time zone.
Return Value
ETrue if the specified time zone ID is the same as this one, otherwise EFalse.
© Nokia 2005.