RTz Class Reference

class RTz : public RSessionBase

The client interface to the time zone server.

This class performs two basic functions:

1. Converts between UTC time and local time. 2. Sets the current local time zone.

NOTE: The presence of a time zone server will alter the behaviour of the time zone related function calls User::SetUTCOffset() and User::SetUTCTimeAndOffset(). The time zone server is shutdown when the last session (RTz) is closed. Therefore, to maintain consistent time related behaviour, licensees may want to keep a system level time zone server session open at all times.

Exceptional cases occur when a user requests conversion for a non-existent local time or a double local time.

Non-existent local times occur when the local time changes from winter to summer for DST.

For example, 01:59 local time is non-existent on the day of a change to BST in Europe/London since the time changes directly from 12:59:59 to 2:00.

A double local time occurs when the local time changes from summer to winter.

For example, if the time changes at 02:00 AM BST to 01:00 AM GMT then local times between 01:00 and 01:59 occur twice.

The conversion applies the DST offset if the local time value is double and applies the standard UTC offset if the local time does not exists.

This decision makes the conversion process asymmetrical around the discontinuity in the local time when there is a DST change.

An example conversion from a double local time to UTC and from UTC to a double local time is:

01:59 AM BST => 00:59 AM UTC 01:59 AM UTC => 01:59 AM GMT

An example conversion from a non-existent local time to UTC and from UTC to local time is:

01:59 AM GMT => 01:59 AM UTC 01:59 AM UTC => 02:59 AM BST

Since
9.1

Inherits from

Public Member Functions
RTz()
~RTz()
IMPORT_C TIntAutoUpdateSettingL()
TInt CancelRequestForNotice()
IMPORT_C voidClose()
IMPORT_C TIntConnect()
IMPORT_C TIntConvertToLocalTime(TTime &)
IMPORT_C TIntConvertToLocalTime(TTime &, const CTzId &)
IMPORT_C TIntConvertToUniversalTime(TTime &)
IMPORT_C TIntConvertToUniversalTime(TTime &, const CTzId &)
CTzId *CreateUserTimeZoneL(const CTzRules &, const CTzUserNames &)
TUint16 CurrentCachedTzId()
voidDeleteUserTimeZoneL(const CTzId &)
IMPORT_C voidGetOffsetsForTimeZoneIdsL(const RArray< TInt > &, RArray< TInt > &)
IMPORT_C CTzId *GetTimeZoneIdL()
IMPORT_C CTzRules *GetTimeZoneRulesL(const TTime &, const TTime &, TTzTimeReference)
IMPORT_C CTzRules *GetTimeZoneRulesL(const CTzId &, const TTime &, const TTime &, TTzTimeReference)
voidGetUserTimeZoneIdsL(RPointerArray< CTzId > &)
CTzUserNames *GetUserTimeZoneNamesL(const CTzId &)
IMPORT_C TBoolIsDaylightSavingOnL(CTzId &)
IMPORT_C TBoolIsDaylightSavingOnL(CTzId &, const TTime &)
IMPORT_C voidLocalizationCloseDbL()
IMPORT_C voidLocalizationDeleteCityL(const TDesC &, TInt)
IMPORT_C voidLocalizationOpenDbL()
IMPORT_C CTzLocalizedCityRecord *LocalizationReadCachedTimeZoneCityL(TInt)
IMPORT_C voidLocalizationReadCitiesInGroupL(RPointerArray< CTzLocalizedCityRecord > &, TUint8)
IMPORT_C voidLocalizationReadCitiesL(RPointerArray< CTzLocalizedCityRecord > &)
IMPORT_C voidLocalizationReadCitiesL(RPointerArray< CTzLocalizedCityRecord > &, TInt)
IMPORT_C CTzLocalizedTimeZoneRecord *LocalizationReadFrequentlyUsedZoneL(TInt)
IMPORT_C voidLocalizationWriteAllFrequentlyUsedZonesL(const RPointerArray< CTzLocalizedTimeZoneRecord > &, const RPointerArray< CTzLocalizedCityRecord > &)
IMPORT_C voidLocalizationWriteCityL(const TDesC &, TInt, TUint8, TUint)
IMPORT_C voidLocalizationWriteFrequentlyUsedZoneL(const CTzLocalizedTimeZoneRecord &, const CTzLocalizedCityRecord &, TInt)
IMPORT_C voidNotifyHomeTimeZoneChangedL(const NTzUpdate::TTimeZoneChange &)
IMPORT_C voidPanic(TPanic)
voidRegisterTzChangeNotifier(TRequestStatus &)
IMPORT_C voidSetAutoUpdateBehaviorL(TTzAutoDSTUpdateModes)
IMPORT_C TIntSetHomeTime(const TTime &)
IMPORT_C voidSetTimeZoneL(CTzId &)
IMPORT_C voidSetUnknownZoneTimeL(const TTime &, const TInt)
IMPORT_C voidSetUnknownZoneTimeL(const TTime &, const TInt, TBool)
TBool StartCachingL()
IMPORT_C voidSwiObsBeginL()
IMPORT_C voidSwiObsEndL()
IMPORT_C voidSwiObsFileChangedL(TSWIObserverFilterIndex)
voidUpdateUserTimeZoneL(const CTzId &, const CTzRules &, const CTzUserNames &)
TVersion Version()
IMPORT_C void__dbgClearCacheL(TBool)
IMPORT_C TInt__dbgRequestAllocatedCellsL(TInt)
IMPORT_C void__dbgResetHeapL()
IMPORT_C void__dbgSetHeapFailL(RAllocator::TAllocFail, TInt)
Private Member Functions
TInt DoConnect()
TInt StartServer()
voiddoConvertL(const CTzId &, TTime &, TTzTimeReference)
voiddoConvertL(TTime &, TTzTimeReference)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Public Member Enumerations
enumTPanic {
EPanicServerNotFound = 1, EPanicServerDead, EPanicTimeZoneNameIdNotSet, EPanicRulesIndexOutofRange, EPanicTimeNotCoveredByRules, EPanicBadTimeZoneRules, EPanicUnsupportedTimeReference, EPanicUnsupportedTimeZoneNoId, EPanicNotificationRequestPending, EPanicInvalidArgument, EPanicBadSchema
}
enumTSWIObserverFilterIndex { EFilterTzPrivate = 0, EFilterResourceTimezonelocalization }
enumTTzAutoDSTUpdateModes { ETZAutoDSTUpdateOff = 0, ETZAutoDSTUpdateOn, ETZAutoDSTNotificationOnly }
enumTTzChanges { ETZDatabaseChanged = 1, ETZSystemTimeZoneChanged, ETZDSTRuleChanged, ETZAutomaticTimeUpdate, ETZLocalizationDataChanged }
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
CTzRuleHolder *iRulesHolder
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RTz()

IMPORT_CRTz()

Constructor.

~RTz()

IMPORT_C~RTz()

Destructor. Calls Close().

Member Functions Documentation

AutoUpdateSettingL()

IMPORT_C TIntAutoUpdateSettingL()

Retrieves the daylight saving auto-update functionality.

CancelRequestForNotice()

TInt CancelRequestForNotice()const

Close()

IMPORT_C voidClose()

Closes the connection to the time zone server.

Connect()

IMPORT_C TIntConnect()
Connects to the time zone server, attempting to start it if necessary.
panic
TzServer 1 The attempt to connect to the server failed with an error code other than KErrNotFound.

ConvertToLocalTime(TTime &)

IMPORT_C TIntConvertToLocalTime(TTime &aTime)const

Converts a time from UTC to local (wall-clock) time for the current system time zone. If caching has been enabled by the CTzConverter class, then the conversion will be done using the cache instead of issuing a request to the server.

Parameters

TTime & aTimeOn entry, contains the UTC time to be converted, and the converted value on exit.

ConvertToLocalTime(TTime &, const CTzId &)

IMPORT_C TIntConvertToLocalTime(TTime &aTime,
const CTzId &aZone
)const

Converts a time from UTC to the local (wall-clock) time for the specified time zone.

Parameters

TTime & aTimeOn entry, contains the UTC time to be converted, and the converted value on exit.
const CTzId & aZoneTime zone ID.

ConvertToUniversalTime(TTime &)

IMPORT_C TIntConvertToUniversalTime(TTime &aTime)const

Converts a local (wall-clock) time for the current system time zone, to UTC. If caching has been enabled by the CTzConverter class, then the conversion will be done using the cache instead of issuing a request to the server.

Parameters

TTime & aTimeOn entry, contains the local time to be converted, and the converted value on exit.

ConvertToUniversalTime(TTime &, const CTzId &)

IMPORT_C TIntConvertToUniversalTime(TTime &aTime,
const CTzId &aZone
)const

Converts a local (wall-clock) time for the specified time zone, to UTC.

Parameters

TTime & aTimeOn entry, contains the local time to be converted, and the converted value on exit.
const CTzId & aZoneThe time zone ID of interest.

CreateUserTimeZoneL(const CTzRules &, const CTzUserNames &)

CTzId *CreateUserTimeZoneL(const CTzRules &aTzUserRules,
const CTzUserNames &aTzUserNames
)

Parameters

const CTzRules & aTzUserRules
const CTzUserNames & aTzUserNames

CurrentCachedTzId()

TUint16 CurrentCachedTzId()

DeleteUserTimeZoneL(const CTzId &)

voidDeleteUserTimeZoneL(const CTzId &aTzId)

Parameters

const CTzId & aTzId

DoConnect()

TInt DoConnect()[private]

GetOffsetsForTimeZoneIdsL(const RArray< TInt > &, RArray< TInt > &)

IMPORT_C voidGetOffsetsForTimeZoneIdsL(const RArray< TInt > &aTzNumericIds,
RArray< TInt > &aOffsets
)const

Retrieves the UTC offset for an array of numeric time zone ids. The offset is written back into aOffsets.

Parameters

const RArray< TInt > & aTzNumericIdsAn array of numeric time zone IDs for which the current UTC offset is required.
RArray< TInt > & aOffsetsAn array that, on return, will contain the UTC offsets corresponding to the the time zone IDs in aTzNumericIds.

GetTimeZoneIdL()

IMPORT_C CTzId *GetTimeZoneIdL()const

This should not be used externally.

Retrieves the time zone ID for the current system time zone.
leave
KErrNoMemory or another system leave code.

GetTimeZoneRulesL(const TTime &, const TTime &, TTzTimeReference)

IMPORT_C CTzRules *GetTimeZoneRulesL(const TTime &aStartTime,
const TTime &aEndTime,
TTzTimeReferenceaTimeRef
)const

Retrieves the time zone rules for the current home time zone.

Parameters

const TTime & aStartTimeThe start date to generate the time zone rules from.
const TTime & aEndTimeThe end date to generate the time zone rules to.
TTzTimeReference aTimeRefWhether to generate the rules relative to UTC or local time. Use ETzUtcTimeReference to generate from UTC, ETzWallTimeReference to generate from local time.

GetTimeZoneRulesL(const CTzId &, const TTime &, const TTime &, TTzTimeReference)

IMPORT_C CTzRules *GetTimeZoneRulesL(const CTzId &aZone,
const TTime &aStartTime,
const TTime &aEndTime,
TTzTimeReferenceaTimeRef
)const

Retrieves the time zone rules for a specified time zone.

Parameters

const CTzId & aZoneThe time zone to generate the rules for.
const TTime & aStartTimeThe start date to generate the time zone rules from.
const TTime & aEndTimeThe end date to generate the time zone rules to.
TTzTimeReference aTimeRefWhether to generate the rules relative to UTC or local time. Use ETzUtcTimeReference to generate from UTC, ETzWallTimeReference to generate from local time.

GetUserTimeZoneIdsL(RPointerArray< CTzId > &)

voidGetUserTimeZoneIdsL(RPointerArray< CTzId > &aTzIds)const

Parameters

RPointerArray< CTzId > & aTzIds

GetUserTimeZoneNamesL(const CTzId &)

CTzUserNames *GetUserTimeZoneNamesL(const CTzId &aTzId)const

Parameters

const CTzId & aTzId

IsDaylightSavingOnL(CTzId &)

IMPORT_C TBoolIsDaylightSavingOnL(CTzId &aZone)const

Tells if daylight savings are applied at the specified zone at the current time

Parameters

CTzId & aZoneThe time zone ID.

IsDaylightSavingOnL(CTzId &, const TTime &)

IMPORT_C TBoolIsDaylightSavingOnL(CTzId &aZone,
const TTime &aUTCTime
)const

Tells if daylight savings are applied at the specified zone at a specified time

Parameters

CTzId & aZoneThe time zone ID.
const TTime & aUTCTimeThe UTC time at which DST settings are required.

LocalizationCloseDbL()

IMPORT_C voidLocalizationCloseDbL()

LocalizationDeleteCityL(const TDesC &, TInt)

IMPORT_C voidLocalizationDeleteCityL(const TDesC &aCityName,
TIntaCityTzId
)

Deletes aCity from the user added cities database table. The city is checked first to ensure it exists. Name checking is case sensitive.

Parameters

const TDesC & aCityNameThe name of the city to delete from the database.
TInt aCityTzIdThe numeric identifier of the city to delete from the database.

LocalizationOpenDbL()

IMPORT_C voidLocalizationOpenDbL()

LocalizationReadCachedTimeZoneCityL(TInt)

IMPORT_C CTzLocalizedCityRecord *LocalizationReadCachedTimeZoneCityL(TIntaFrequentlyUsedZone)

Retrieves the city used to select this time zone if set. If the time zone was not originally set using a city then the default city for the time zone will be returned instead.

Parameters

TInt aFrequentlyUsedZone- The cached zone to find the city for

LocalizationReadCitiesInGroupL(RPointerArray< CTzLocalizedCityRecord > &, TUint8)

IMPORT_C voidLocalizationReadCitiesInGroupL(RPointerArray< CTzLocalizedCityRecord > &aCities,
TUint8aGroupId
)

Reads all the user defined cities stored in the database with a matching group id. If the database is empty the returned array will contain no elements.

Parameters

RPointerArray< CTzLocalizedCityRecord > & aCitiesArray of cities to add the user defined cities to.
TUint8 aGroupIdA city group id

LocalizationReadCitiesL(RPointerArray< CTzLocalizedCityRecord > &)

IMPORT_C voidLocalizationReadCitiesL(RPointerArray< CTzLocalizedCityRecord > &aCities)

Reads all the user defined cities stored in the database. If the database is empty the returned array will contain no elements.

Parameters

RPointerArray< CTzLocalizedCityRecord > & aCitiesArray of cities to add the user defined to.

LocalizationReadCitiesL(RPointerArray< CTzLocalizedCityRecord > &, TInt)

IMPORT_C voidLocalizationReadCitiesL(RPointerArray< CTzLocalizedCityRecord > &aCities,
TIntaTimeZoneId
)

Reads all the user defined cities stored in the database that are members of the time zone referenced by aTimeZoneid. If the database is empty the returned array will contain no elements.

Parameters

RPointerArray< CTzLocalizedCityRecord > & aCitiesArray of cities to add the user defined cities to.
TInt aTimeZoneIdA time zone id identifying a time zone

LocalizationReadFrequentlyUsedZoneL(TInt)

IMPORT_C CTzLocalizedTimeZoneRecord *LocalizationReadFrequentlyUsedZoneL(TIntaFrequentlyUsedZone)

Retrieves a cached zone from the database. The calling function takes ownership of the returned zone

Parameters

TInt aFrequentlyUsedZone- The cached zone to return

LocalizationWriteAllFrequentlyUsedZonesL(const RPointerArray< CTzLocalizedTimeZoneRecord > &, const RPointerArray< CTzLocalizedCityRecord > &)

IMPORT_C voidLocalizationWriteAllFrequentlyUsedZonesL(const RPointerArray< CTzLocalizedTimeZoneRecord > &aTimeZones,
const RPointerArray< CTzLocalizedCityRecord > &aCities
)

Parameters

const RPointerArray< CTzLocalizedTimeZoneRecord > & aTimeZones
const RPointerArray< CTzLocalizedCityRecord > & aCities

LocalizationWriteCityL(const TDesC &, TInt, TUint8, TUint)

IMPORT_C voidLocalizationWriteCityL(const TDesC &aCityName,
TIntaCityTzId,
TUint8aCityGroupId,
TUintaCityTzResourceId
)

Adds aCity into the user added cities database table. The city is checked first to prevent two cities with identical names and time zones existing at the same time. Name checking is case sensitive. Cities in different time zones can have the same name.

Parameters

const TDesC & aCityNameThe name of the city to add to the database
TInt aCityTzIdThe time zone of the city
TUint8 aCityGroupIdThe group id
TUint aCityTzResourceIdThe resource id

LocalizationWriteFrequentlyUsedZoneL(const CTzLocalizedTimeZoneRecord &, const CTzLocalizedCityRecord &, TInt)

IMPORT_C voidLocalizationWriteFrequentlyUsedZoneL(const CTzLocalizedTimeZoneRecord &aTimeZone,
const CTzLocalizedCityRecord &aCity,
TIntaFrequentlyUsedZone
)

Stores the localized time zone in the database for easy retrieval. The database keeps track of the two most recently used zones, these are updated every time a new zone is set. The zone to be replaced becomes recently used zone 1, and recently used zone 1 becomes recently used zone 2. The old recently used zone 2 is discarded.

Parameters

const CTzLocalizedTimeZoneRecord & aTimeZoneTime zone names information to store in the given frequently used time zone.
const CTzLocalizedCityRecord & aCityCity associated with the time zone names to store in the given frequently used time zone.
TInt aFrequentlyUsedZoneWhich frequently used time zone to overwrite in the database.

NotifyHomeTimeZoneChangedL(const NTzUpdate::TTimeZoneChange &)

IMPORT_C voidNotifyHomeTimeZoneChangedL(const NTzUpdate::TTimeZoneChange &aChange)const

Publish notification that the home time zone (as defined in CTzLocalizer) has been changed. This function should only be called from TimeZoneLocalization.

Parameters

const NTzUpdate::TTimeZoneChange & aChangeTime zone change information.

Panic(TPanic)

IMPORT_C voidPanic(TPanicaPanic)[static]

This should not be used externally.

Panics the TzClient or TzServer code.

Parameters

TPanic aPanic

RegisterTzChangeNotifier(TRequestStatus &)

voidRegisterTzChangeNotifier(TRequestStatus &aStatus)const

Parameters

TRequestStatus & aStatus

SetAutoUpdateBehaviorL(TTzAutoDSTUpdateModes)

IMPORT_C voidSetAutoUpdateBehaviorL(TTzAutoDSTUpdateModesaUpdateEnabled)

Sets the configuration of the UTC Offset auto-update functionality.

Parameters

TTzAutoDSTUpdateModes aUpdateEnabledIf set to RTz::ETZAutoDSTUpdateOn then the UTC Offset is automatically updated for changes to Daylight Savings Time. If set to RTz::ETZAutoDSTUpdateOff then auto-update is disabled. The RTz::ETZAutoDSTNotificationOnly - Means that the client app needs to confirm that the time should be updated whenever a DST event occurs.

SetHomeTime(const TTime &)

IMPORT_C TIntSetHomeTime(const TTime &aLocalTime)const

Sets the system time to the given local time. Note that the standard Tz algorithm is used - in the case of an ambiguous time the first occurance of the given local wall-clock time is chosen.

An example of an ambiguous time: 01:30 wall-clock time on 31/10/2004 in the UK could map to either 01:30 BST (00:30 GMT) or 01:30 GMT, as the clocks would go back at 02:00 BST (01:00 GMT))

capability
WriteDeviceData

Parameters

const TTime & aLocalTimeThe time to set in wall-clock time.

SetTimeZoneL(CTzId &)

IMPORT_C voidSetTimeZoneL(CTzId &aZone)const

This should not be used externally.

Sets the current system time zone information to that corresponding to the supplied time zone ID.
capability
WRITE_DEVICE_DATA

Parameters

CTzId & aZoneThe time zone ID.

SetUnknownZoneTimeL(const TTime &, const TInt)

IMPORT_C voidSetUnknownZoneTimeL(const TTime &aUTCTime,
const TIntaUTCOffset
)

Sets the UTC time and the wall-clock offset for a zone not defined in the Timezone Database.

This is useful when the client wants to specify the UTC time and the wall-clock offset explicitly rather than using time zones. This function should be used instead of User::SetUTCOffset() and User::SetUTCTimeAndOffset().

If this function has been called the time zone server will use the value returned by User::UTCOffset() as the offset value when doing time conversions. Calling User::SetUTCOffset() may therefore cause unexpected results.

The fact that the time zone has been set to the unknown time zone is not persisted across time zone server reboots. So it may be necessary to call this function each time the time zone server is started. If persistence across reboots is desired the overload RTz::SetUnknownZoneTimeL(const TTime& aUTCTime, const TInt aUTCOffset, TBool aPersistInCenRep) should be used.

Parameters

const TTime & aUTCTimeUniversal Time to set the device time to.
const TInt aUTCOffsetOffset (in minutes) in use in the time zone.

SetUnknownZoneTimeL(const TTime &, const TInt, TBool)

IMPORT_C voidSetUnknownZoneTimeL(const TTime &aUTCTime,
const TIntaUTCOffset,
TBoolaPersistInCenRep
)

Sets the UTC time and the wall-clock offset for a zone not defined in the Timezone Database.

This is useful when the client wants to specify the UTC time and the wall-clock offset explicitly rather than using time zones. This function should be used instead of User::SetUTCOffset() and User::SetUTCTimeAndOffset().

If this function has been called the time zone server will use the value returned by User::UTCOffset() as the offset value when doing time conversions. Calling User::SetUTCOffset() may therefore cause unexpected results.

The fact that the time zone has been set to the unknown time zone is persisted across time zone server reboots only if the aPersistInCenRep argument is set to ETrue. The desired offset however is never persisted (the value returned by User::UTCOffset() is used). So it may be necessary to call this function each time the time zone server is started.

Parameters

const TTime & aUTCTimeUniversal Time to set the device time to.
const TInt aUTCOffsetOffset (in minutes) in use in the time zone.
TBool aPersistInCenRepIf ETrue the unknown time zone is persisted across reboots else it is not.

StartCachingL()

TBool StartCachingL()

StartServer()

TInt StartServer()[private, static]

SwiObsBeginL()

IMPORT_C voidSwiObsBeginL()

Called by the installation observer plugin to signal the start of an (un)install log.

SwiObsEndL()

IMPORT_C voidSwiObsEndL()

Called by the installation observer plugin to signal the end of an (un)install log.

SwiObsFileChangedL(TSWIObserverFilterIndex)

IMPORT_C voidSwiObsFileChangedL(TSWIObserverFilterIndexaType)

Called by the installation observer plugin to signal that the rules database or the resource files have been changed.

Parameters

TSWIObserverFilterIndex aTypeThe type of file that has changed (resource or rules database).

UpdateUserTimeZoneL(const CTzId &, const CTzRules &, const CTzUserNames &)

voidUpdateUserTimeZoneL(const CTzId &aTzId,
const CTzRules &aTzUserRules,
const CTzUserNames &aTzUserNames
)

Parameters

const CTzId & aTzId
const CTzRules & aTzUserRules
const CTzUserNames & aTzUserNames

Version()

TVersion Version()const

__dbgClearCacheL(TBool)

IMPORT_C void__dbgClearCacheL(TBoolaRestartCaching)

Parameters

TBool aRestartCaching

__dbgRequestAllocatedCellsL(TInt)

IMPORT_C TInt__dbgRequestAllocatedCellsL(TIntaHeapSizeInBytes)

Parameters

TInt aHeapSizeInBytes

__dbgResetHeapL()

IMPORT_C void__dbgResetHeapL()

__dbgSetHeapFailL(RAllocator::TAllocFail, TInt)

IMPORT_C void__dbgSetHeapFailL(RAllocator::TAllocFailaType,
TIntaRate
)

Parameters

RAllocator::TAllocFail aType
TInt aRate

doConvertL(const CTzId &, TTime &, TTzTimeReference)

voiddoConvertL(const CTzId &aZone,
TTime &aTime,
TTzTimeReferenceaTimerRef
)const [private]

Parameters

const CTzId & aZone
TTime & aTime
TTzTimeReference aTimerRef

doConvertL(TTime &, TTzTimeReference)

voiddoConvertL(TTime &aTime,
TTzTimeReferenceaTimerRef
)const [private]

Parameters

TTime & aTime
TTzTimeReference aTimerRef

Member Enumerations Documentation

Enum TPanic

Time zone server panic codes.

Enumerators

EPanicServerNotFound = 1

This panic indicates that the time zone server has not been found.

EPanicServerDead

This panic indicates that the server has died.

EPanicTimeZoneNameIdNotSet

This panic indicates that the time zone ID is not set.

EPanicRulesIndexOutofRange

This panic indicates that an out of range index was accessed.

EPanicTimeNotCoveredByRules

This panic indicates that there are no rules present for this time zone.

EPanicBadTimeZoneRules

This panic indicates that the time zone rules are unusable.

EPanicUnsupportedTimeReference

This panic indicates that an unsupported time reference has been accessed.

EPanicUnsupportedTimeZoneNoId

This panic indicates that the time zone ID is not supported.

EPanicNotificationRequestPending

This panic indicates that a request for notification is already pending from the client.

EPanicInvalidArgument

This panic indicates that an incorrect data has been sent to the server.

EPanicBadSchema

This panic indicates that a table in the user-defined time zone database has not conformed to the declared schema.

Enum TSWIObserverFilterIndex

The software install observer plugin can distinguish between changes to the resource files or the rules database. This enumeration indicates the filter index that is used for the resource files and rules database filters. This enum should not be used externally.

Enumerators

EFilterTzPrivate = 0

The index of the Tz private directory filter.

EFilterResourceTimezonelocalization

The index of the resources filter.

Enum TTzAutoDSTUpdateModes

Automatic DST update mode.

Enumerators

ETZAutoDSTUpdateOff = 0

No auto update notification when a DST event occurs.

ETZAutoDSTUpdateOn

Automatic time update will occur and the client app will be notified.

ETZAutoDSTNotificationOnly

Client app needs to confirm that the time should be updated whenever a DST event occurs.

Enum TTzChanges

Time zone server change events.

Enumerators

ETZDatabaseChanged = 1

Used for notifying that the timezone database has changed.

ETZSystemTimeZoneChanged

Used for notifying that the system timezone has changed.

ETZDSTRuleChanged

Used for notifying that the DST rule has changed.

ETZAutomaticTimeUpdate

Used for notifying that an automatic time update has taken place.

ETZLocalizationDataChanged

Used for notifying that a change in localization resources has taken place.

Member Data Documentation

CTzRuleHolder * iRulesHolder

CTzRuleHolder *iRulesHolder[private]