devicesrv_pub/version_info_api/inc/versioninfo.h
changeset 0 4e1aa6a622a0
child 78 3f0699f2e14c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/devicesrv_pub/version_info_api/inc/versioninfo.h	Tue Feb 02 00:53:00 2010 +0200
@@ -0,0 +1,146 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Interface for quering system version information.
+*
+*/
+
+
+
+#ifndef VERSION_INFO_H
+#define VERSION_INFO_H
+
+//  INCLUDES
+#include <e32std.h>
+
+// FORWARD DECLARATIONS
+class RFs;
+
+// CLASS DECLARATION
+/**
+* Class holds system version information. Version Info API provides 
+* an interface for quering system version information.
+*
+* Usage:
+*  
+* Get platform version information:
+* @code
+* // iFs contains open file server session
+*
+* VersionInfo::TPlatformVersion platformVersion;
+* // Select the overload of VersionInfo::GetVersion() that suits best for 
+* // the current client.
+* User::LeaveIfError( VersionInfo::GetVersion( platformVersion, iFs ) );
+*
+* // Now platformVersion contains platform version information.
+*
+* @endcode
+*
+* @lib platformver.lib
+* @since S60 3.2
+*/
+
+NONSHARABLE_CLASS(VersionInfo)
+    {
+
+public:
+    /**
+    * Class TVersionBase is a base class for all version information data.
+    * @since S60 3.2
+    */
+    class TVersionBase
+        {
+    friend class VersionInfo;
+
+    protected:
+        /**
+        * Constructor for subclasses
+        * @since S60 3.2
+        * @param aType Sets type of version info specified by TVersionType
+        */
+        inline TVersionBase( TInt aType );
+
+    private:
+        /**
+        * C++ default constructor.
+        */
+        TVersionBase();
+
+    private:
+        /**  Contains type of version info specified by TVersionType */
+        TInt iType;
+        };
+
+    /**
+    * Class TPlatformVersion stores platform version information.
+    * The class is used as parameter in GetVersionInfo() methods.
+    * @since S60 3.2
+    */
+    class TPlatformVersion : public TVersionBase
+        {
+    public:
+        /**
+         * C++ default constructor.
+        */
+        inline TPlatformVersion();
+
+    public:
+        /**  Contains the major version. For example 3 if S60 3.2 */
+        TUint16 iMajorVersion;
+
+        /**  Contains the minor version. For example 2 if S60 3.2 */
+        TUint16 iMinorVersion;
+        };
+
+    /**
+    * This method gets the version information.
+    *
+    * @since S60 3.2
+    * @param aVersion Stores the version information
+    * @return System wide error code
+    *
+    * @see TVersionBase
+    */
+    IMPORT_C static TInt GetVersion( TVersionBase& aVersion );
+
+    /**
+    * This method gets the version information. Given file server 
+    * session avoids the overhead of new file server connection. 
+    *
+    * @since S60 3.2
+    * @param aVersion Stores the version information
+    * @param aFs An opened file server session
+    * @return System wide error code
+    *
+    * @see TVersionBase
+    */
+    IMPORT_C static TInt GetVersion( TVersionBase& aVersion, RFs& aFs );
+
+private:
+    /**
+     * C++ default constructor.
+     */
+    VersionInfo();
+
+    /** Used internally to detect type of version info */
+    enum TVersionType
+        {
+        EPlatformVersion = 0
+        };
+    };
+
+#include "versioninfo.inl"
+
+#endif // VERSION_INFO_H
+
+// End of File