CTzUserNames Class Reference

#include <mw/tz.h>

Link against: tzclient.lib

class CTzUserNames : public CBase

Inherits from

  • CTzUserNames

    Detailed Description

    The CTzUserNames class is used to encapsulate the names for a user-defined time zone.

    When creating an instance of this class the client can specify the following names:

    • Long standard time name, for example "Mountain Standard Time"

    • Short standard time name, for example "MST"

    • Long daylight saving time name, for example "Mountain Daylight Time"

    • Short daylight saving time name, for example "MDT"

    • City name, for example "Shiprock"

    • Region name, for example "America"

    The client can also read these names.

    Constructor & Destructor Documentation

    ~CTzUserNames ( )

    IMPORT_C~CTzUserNames()

    Destroys this CTzUserNames object.

    Member Function Documentation

    CityName ( )

    IMPORT_C const TDesC &CityName()const

    Returns the city name for this object.

    Returns: The city name for this object.

    DaylightSaveName ( )

    IMPORT_C const TDesC &DaylightSaveName()const

    Returns the daylight saving time name for this object.

    Returns: The daylight saving time name for this object.

    ExternalizeL ( RWriteStream & )

    IMPORT_C voidExternalizeL(RWriteStream &aStream)const

    Externalises user-defined time zone names to the given stream.

    ParameterDescription
    aStreamStream to which the object should be externalised.

    InternalizeL ( RReadStream & )

    IMPORT_C voidInternalizeL(RReadStream &aStream)

    Internalizes user-defined time zone names from the given read stream.

    ParameterDescription
    aStreamStream from which the object should be internalised.

    NewL ( const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC & )

    IMPORT_C CTzUserNames *NewL(const TDesC &aStandardName,
    const TDesC &aShortStandardName,
    const TDesC &aDaylightSaveName,
    const TDesC &aShortDaylightSaveName,
    const TDesC &aCityName,
    const TDesC &aRegionName
    )[static]

    Creates a user-defined time zone names object from the given names.

    ParameterDescription
    aStandardNameThe standard time name.
    aShortStandardNameThe short standard time name.
    aDaylightSaveNameThe daylight saving time name.
    aShortDaylightSaveNameThe short daylight saving time name.
    aCityNameThe city name.
    aRegionNameThe region name.

    Returns: Pointer to a fully initialised instance of the CTzUserNames class. The caller takes ownership of this object.

    NewL ( RReadStream & )

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

    Creates a new user-defined time zone names object from the given stream.

    ParameterDescription
    aStreamStream with the time zone rules to be used to create a CTzRules object.

    Returns: Pointer to a fully initialised instance of the CTzUserNames class. The caller takes ownership of this object.

    NewLC ( const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC &, const TDesC & )

    IMPORT_C CTzUserNames *NewLC(const TDesC &aStandardName,
    const TDesC &aShortStandardName,
    const TDesC &aDayLightSaveName,
    const TDesC &aShortDaylightSaveName,
    const TDesC &aCityName,
    const TDesC &aRegionName
    )[static]

    Creates a user-defined time zone names object from the given names leaving the newly created object on the cleanup stack.

    ParameterDescription
    aStandardNameThe standard time name.
    aShortStandardNameThe short standard time name.
    aDayLightSaveNameThe daylight saving time name.
    aShortDaylightSaveNameThe short daylight saving time name.
    aCityNameThe city name.
    aRegionNameThe region name.

    Returns: Pointer to a fully initialised instance of the CTzUserNames class. The caller takes ownership of this object.

    RegionName ( )

    IMPORT_C const TDesC &RegionName()const

    Returns the region name for this object.

    Returns: The region name for this object.

    ShortDaylightSaveName ( )

    IMPORT_C const TDesC &ShortDaylightSaveName()const

    Returns the short daylight saving time name for this object.

    Returns: The short daylight saving time name for this object.

    ShortStandardName ( )

    IMPORT_C const TDesC &ShortStandardName()const

    Returns the short standard time name for this object.

    Returns: The short standard time name for this object.

    SizeOfObject ( )

    IMPORT_C TIntSizeOfObject()const

    Determines the size of this object.

    Returns: The size of CTzUserNames object.

    StandardName ( )

    IMPORT_C const TDesC &StandardName()const

    Returns the standard time name for this object.

    Returns: The standard time name for this object