1.1 --- a/epoc32/include/connect/sbdefs.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/connect/sbdefs.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,94 @@
     1.4 -sbdefs.h
     1.5 +/**
     1.6 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:
    1.19 +* Declaration of Types and Constants for Secure Backup and Restore
    1.20 +* 
    1.21 +*
    1.22 +*/
    1.23 +
    1.24 +
    1.25 +
    1.26 +
    1.27 +
    1.28 +/**
    1.29 + @file
    1.30 +*/
    1.31 +#ifndef __SBDEFS_H__
    1.32 +#define __SBDEFS_H__
    1.33 +
    1.34 +#include <e32std.h>
    1.35 +#include <f32file.h>
    1.36 +
    1.37 +namespace conn
    1.38 +	{
    1.39 +	/** Secure Backup and Restore publish and subscribe key
    1.40 +
    1.41 +	Secure Backup and Restore uses a Publish and Subscribe key to publish
    1.42 +	the current backup / restore state.
    1.43 + 
    1.44 +	The key is a system key so the category to be used when subscribing is KUidSystemCategoryValue
    1.45 +	The key to be used is KUidBackupRestoreKey.
    1.46 +	The value is a bit-wise OR of a TBURPartType value and a TBackupIncType value
    1.47 +	This means that a normal state (i.e. non-backup or restore) is EBURNormal | ENoBackup but
    1.48 +	If the key has not been set (i.e. == 0) then no backup or restore is in progress either
    1.49 +
    1.50 +	@released
    1.51 +	@publishedAll
    1.52 +	*/
    1.53 +	const TUint KUidBackupRestoreKey = 0x10202792 ;
    1.54 +
    1.55 +
    1.56 +	/** TBURPartType Bitmask
    1.57 +	@released
    1.58 +	@publishedAll
    1.59 +	*/
    1.60 +	const TUint KBURPartTypeMask = 0xff;
    1.61 +
    1.62 +	enum TBURPartType
    1.63 +		/** 
    1.64 +		The backup / restore state of a device.
    1.65 +
    1.66 +		@released
    1.67 +		@publishedAll
    1.68 +		*/
    1.69 +		{
    1.70 +		EBURUnset          = 0x00000000, /*!< 0x00000000: The backup / restore mode has not been set */
    1.71 +		EBURNormal         = 0x00000001, /*!< 0x00000001: The device as a whole is not engaged in a backup or restore */
    1.72 +		EBURBackupFull     = 0x00000002, /*!< 0x00000002: The device as a whole is engaged in a backup of all components data */
    1.73 +		EBURBackupPartial  = 0x00000004, /*!< 0x00000004: The device as a whole is engaged in a backup of selected components data */
    1.74 +		EBURRestoreFull    = 0x00000008, /*!< 0x00000008: The device as a whole is engaged in a restore of all components data */
    1.75 +		EBURRestorePartial = 0x00000010  /*!< 0x00000010: The device as a whole is engaged in a restore of all components data */
    1.76 +		};
    1.77 +
    1.78 +	/** TBackupIncType Bitmask
    1.79 +	@released
    1.80 +	@publishedAll
    1.81 +	*/
    1.82 +	const TUint KBackupIncTypeMask = 0xffffff00;
    1.83 +
    1.84 +	enum TBackupIncType
    1.85 +		/** 
    1.86 +		The type of a backup.
    1.87 +
    1.88 +		@released
    1.89 +		@publishedAll
    1.90 +		*/
    1.91 +		{
    1.92 +		ENoBackup        = 0x00000000, /*!< 0x00000000: No backup is in progress */
    1.93 +		EBackupBase      = 0x00000100, /*!< 0x00000100: The backup is a base backup, i.e. it includes all files / data */
    1.94 +		EBackupIncrement = 0x00000200  /*!< 0x00000200: The backup is an incremental backup, i.e. it includes only files / data that have changed since a previous backup */
    1.95 +		};
    1.96 +
    1.97 +	} // end namespace
    1.98 +#endif