Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
TVersion Class Reference

Contains version information. More...

#include <e32cmn.h>

Public Member Functions

IMPORT_C TVersion ()
 Default constructor.
 
IMPORT_C TVersion (TInt aMajor, TInt aMinor, TInt aBuild)
 Constructs the object with the specified major version number, the minor version number and the build number.
 
IMPORT_C TVersionName Name () const
 Gets a descriptor buffer containing the formatted character representation of the version information.
 

Public Attributes

TInt8 iMajor
 The major version number.
 
TInt8 iMinor
 The minor version number.
 
TInt16 iBuild
 The build number.
 

Detailed Description

Contains version information.

A version is defined by a set of three numbers:

  1. the major version number, ranging from 0 to 127, inclusive
  2. the minor version number, ranging from 0 to 99 inclusive
  3. the build number, ranging from 0 to 32767 inclusive.

The class provides a constructor for setting all three numbers. It also provides a member function to build a character representation of this information in a TVersionName descriptor.

See also
TVersionName
API status
Published to all clients. Released API.

Definition at line 2199 of file e32cmn.h.

Constructor & Destructor Documentation

◆ TVersion() [1/2]

IMPORT_C TVersion::TVersion ( )

Default constructor.

It sets the major, minor and build numbers to zero.

(generated from Symbian Developer Library)

◆ TVersion() [2/2]

IMPORT_C TVersion::TVersion ( TInt  aMajor,
TInt  aMinor,
TInt  aBuild 
)

Constructs the object with the specified major version number, the minor version number and the build number.

Note that the constructor does not check that the values passed are within the specified ranges. As the parameters are TInt types, care must be taken to ensure that values passed do not exceed the specified maxima, otherwise they will be interpreted as negative values.

Parameters
aMajorThe major version number. This must be a number in the range 0 to 127.
aMinorThe minor version number. This must be a number in the range 0 to 99.
aBuildThe build number. This must be a number in the range 0 to 32,767.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Name()

IMPORT_C TVersionName TVersion::Name ( ) const

Gets a descriptor buffer containing the formatted character representation of the version information.

The general format of the representation is: xxx.yy(zzzzz)

where:

  1. xxx is the major version number; depending on the value, this may have a length of one, two or three characters.
  2. yy is the minor version number; this is always two characters, padded with a leading zero, if necessary.
  3. zzzzz is the build number; depending on the value, this may have a length of one to 5 characters.

Note that if the object is constructed with values that exceed the permitted range, they will appear negative in their formatted character representation.

(generated from Symbian Developer Library)

Member Data Documentation

◆ iBuild

TInt16 TVersion::iBuild

The build number.

Definition at line 2221 of file e32cmn.h.

◆ iMajor

TInt8 TVersion::iMajor

The major version number.

Definition at line 2209 of file e32cmn.h.

◆ iMinor

TInt8 TVersion::iMinor

The minor version number.

Definition at line 2215 of file e32cmn.h.

The documentation for this class was generated from the following files: