Collapse all Symbian^3 Product Developer Library

SysVersionInfo Class Reference

class SysVersionInfo

Extended Version Info API provides extended version information i.e. firmware, operator etc version information.

Usage:

Get the version information:

 // iFs contains open file server session

 TBuf< KSysVersionInfoTextLength > info;
 User::LeaveIfError( SysVersionInfo::GetVersionInfo(
   SysVersionInfo::EFWVersion, info, iFs ) );

 // Now info contains firmware version information

 SysVersionInfo::TSymbianOSVersion osVersion;
 User::LeaveIfError( SysVersionInfo::GetVersionInfo( osVersion, iFs ) );

  // Now osVersion contains the Symbian OS version information

 SysVersionInfo::TProductVersion productVersion;
 User::LeaveIfError( SysVersionInfo::GetVersionInfo( productVersion, iFs ) );

  // Now productVersion contains the product version information

sysversioninfo.lib

Since: S60 3.2

Nested Classes and Structures

Public Member Functions
IMPORT_C TInt	GetVersionInfo(const TVersionInfoType, TDes &)
IMPORT_C TInt	GetVersionInfo(const TVersionInfoType, TDes &, RFs &)
IMPORT_C TInt	GetVersionInfo(TVersionBase &)
IMPORT_C TInt	GetVersionInfo(TVersionBase &, RFs &)

Private Member Functions
	SysVersionInfo()

Public Member Enumerations
enum	TVersionInfoType { EFWVersion = 0, EOPVersion, EModelVersion, EProductCode }

Private Member Enumerations
enum	TVersionType { ESymbianOSVersion = 0, EProductVersion }

Constructor & Destructor Documentation

SysVersionInfo()

SysVersionInfo

(

)

[private]

C++ default constructor.

Member Functions Documentation

GetVersionInfo(const TVersionInfoType, TDes &)

IMPORT_C TInt	GetVersionInfo	(	const TVersionInfoType	aType,
			TDes &	aValue
		)	[static]

This method gets the requested version information as string. The maximum length for the string is KSysVersionInfoTextLength if it has not been explicitly specified by the requested TVersionInfoType definition.

KErrTooBig is returned if the requested version info does not fit into given descriptor. The part that fits is copied to the given descriptor.

Since: S60 3.2

TVersionInfoType KSysVersionInfoTextLength

Parameters

const TVersionInfoType aType	A version information type specified by TVersionInfoType.
TDes & aValue	Stores version information.

GetVersionInfo(const TVersionInfoType, TDes &, RFs &)

IMPORT_C TInt	GetVersionInfo	(	const TVersionInfoType	aType,
			TDes &	aValue,
			RFs &	aFs
		)	[static]

KErrTooBig is returned if the requested version info does not fit into given descriptor. The part that fits is copied to the given descriptor.

Since: S60 3.2

TVersionInfoType KSysVersionInfoTextLength

Parameters

const TVersionInfoType aType	A version information type specified by TVersionInfoType.
TDes & aValue	Stores version information.
RFs & aFs	Open file server session.

GetVersionInfo(TVersionBase &)

IMPORT_C TInt

GetVersionInfo

(

TVersionBase &

aVersion

)

[static]

This method gets the requested version information.

Since: S60 3.2

TVersionBase

Parameters

TVersionBase & aVersion

On return, contains the version information.

GetVersionInfo(TVersionBase &, RFs &)

IMPORT_C TInt	GetVersionInfo	(	TVersionBase &	aVersion,
			RFs &	aFs
		)	[static]

This method gets the requested version information and avoids overhead of creating new file server session.

Since: S60 3.2

TVersionBase

Parameters

TVersionBase & aVersion	On return, contains the version information.
RFs & aFs	Open file server session.

Member Enumerations Documentation

Enum TVersionInfoType

Enumeration TVersionInfoType defines values to be used for the aType parameter in GetVersionInfo method.

Since: S60 3.2

Enumerators

EFWVersion = 0	To get the firmware version that is composed of the version info of multiple images (core + variants images).
EOPVersion	To get the customer software version. This identifies the user friendly version of e.g. operator/country/regional variant image.
EModelVersion	To get the model version.
EProductCode	To get the product code.

Enum TVersionType

Used internally to detect type of version info

Enumerators

ESymbianOSVersion = 0
EProductVersion