Location:
tzconverter.h
Link against: tzclient.lib
class CTzConverter : public CBase;
Description
Converts between time expressed in UTC and local time.
Derivation
CBase
- Base class for all classes to be instantiated on the heap
CTzConverter
- Converts between time expressed in UTC and local time
Members
Defined in CTzConverter
:
ConvertToLocalTime()
, ConvertToLocalTime()
, ConvertToUniversalTime()
, ConvertToUniversalTime()
, CurrentTzId()
, NewL()
, ~CTzConverter()
Inherited from CBase
:
Delete()
,
Extension_()
,
operator new()
See also:
static IMPORT_C CTzConverter *NewL(RTz &aTzServer);
Description
CTzConverter factory method.
Provides client side caching for conversions in the local time zone. Caching is done through RTz
but enabled through this interface. When caching has been enabled by this class and the RTz
functions for local time zone conversion are used, they too will use the cache instead of the server. Multiple CTzConverter's
can use the same RTz
session. Each converter will be notified by the server if the time zone changes, and the cache will be updated appropriately.
To disable caching in RTz
, the session must be closed. Caching will be re-enabled if a CTzConverter associated with the RTz
is later used again for local time zone conversions.
This will leave with KErrNotReady if the RTz
passed in is not connected.
Parameters
RTz &aTzServer |
Connection to the time zone server.
|
|
Return value
CTzConverter *
|
A pointer to the new CTzConverter object. The caller takes ownership.
|
|
IMPORT_C ~CTzConverter();
Description
Destructor.
IMPORT_C TInt ConvertToLocalTime(TTime &aTime);
Description
Converts a time from UTC to local (wall-clock) time for the current system time zone.
Parameters
TTime &aTime |
On entry, contains the UTC time to be converted and the converted value on exit.
|
|
Return value
TInt
|
KErrNone if successful, otherwise another system error code.
|
|
IMPORT_C TInt ConvertToLocalTime(TTime &aTime, const CTzId &aZone);
Description
Converts a time from UTC to the local (wall-clock) time for the specified time zone.
Parameters
TTime &aTime |
On entry, contains the UTC time to be converted, and the converted value on exit.
|
const CTzId &aZone |
Time zone ID.
|
|
Return value
TInt
|
KErrNone if successful, otherwise another system error code.
|
|
IMPORT_C TInt ConvertToUniversalTime(TTime &aTime);
Description
Converts a local (wall-clock) time for the current system time zone into UTC.
Parameters
TTime &aTime |
On entry, contains the local time to be converted, and the converted value on exit.
|
|
Return value
TInt
|
KErrNone if successful, otherwise another system error code.
|
|
IMPORT_C TInt ConvertToUniversalTime(TTime &aTime, const CTzId &aZone);
Description
Converts a local (wall-clock) time for the specified time zone into UTC.
Parameters
TTime &aTime |
On entry, contains the local time to be converted, and the converted value on exit.
|
const CTzId &aZone |
The time zone ID.
|
|
Return value
TInt
|
KErrNone if successful, otherwise another system error code.
|
|
IMPORT_C TUint16 CurrentTzId();
Description
Get the numerical ID of the current time zone.
Return value