epoc32/include/connect/sbdefs.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/**
williamr@2
     2
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Declaration of Types and Constants for Secure Backup and Restore
williamr@2
    16
* 
williamr@2
    17
*
williamr@2
    18
*/
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
/**
williamr@2
    23
 @file
williamr@2
    24
*/
williamr@2
    25
#ifndef __SBDEFS_H__
williamr@2
    26
#define __SBDEFS_H__
williamr@2
    27
williamr@2
    28
#include <e32std.h>
williamr@2
    29
#include <f32file.h>
williamr@2
    30
williamr@2
    31
namespace conn
williamr@2
    32
	{
williamr@2
    33
	/** Secure Backup and Restore publish and subscribe key
williamr@2
    34
williamr@2
    35
	Secure Backup and Restore uses a Publish and Subscribe key to publish
williamr@2
    36
	the current backup / restore state.
williamr@2
    37
 
williamr@2
    38
	The key is a system key so the category to be used when subscribing is KUidSystemCategoryValue
williamr@2
    39
	The key to be used is KUidBackupRestoreKey.
williamr@2
    40
	The value is a bit-wise OR of a TBURPartType value and a TBackupIncType value
williamr@2
    41
	This means that a normal state (i.e. non-backup or restore) is EBURNormal | ENoBackup but
williamr@2
    42
	If the key has not been set (i.e. == 0) then no backup or restore is in progress either
williamr@2
    43
williamr@2
    44
	@released
williamr@2
    45
	@publishedAll
williamr@2
    46
	*/
williamr@2
    47
	const TUint KUidBackupRestoreKey = 0x10202792 ;
williamr@2
    48
williamr@2
    49
williamr@2
    50
	/** TBURPartType Bitmask
williamr@2
    51
	@released
williamr@2
    52
	@publishedAll
williamr@2
    53
	*/
williamr@2
    54
	const TUint KBURPartTypeMask = 0xff;
williamr@2
    55
williamr@2
    56
	enum TBURPartType
williamr@2
    57
		/** 
williamr@2
    58
		The backup / restore state of a device.
williamr@2
    59
williamr@2
    60
		@released
williamr@2
    61
		@publishedAll
williamr@2
    62
		*/
williamr@2
    63
		{
williamr@2
    64
		EBURUnset          = 0x00000000, /*!< 0x00000000: The backup / restore mode has not been set */
williamr@2
    65
		EBURNormal         = 0x00000001, /*!< 0x00000001: The device as a whole is not engaged in a backup or restore */
williamr@2
    66
		EBURBackupFull     = 0x00000002, /*!< 0x00000002: The device as a whole is engaged in a backup of all components data */
williamr@2
    67
		EBURBackupPartial  = 0x00000004, /*!< 0x00000004: The device as a whole is engaged in a backup of selected components data */
williamr@2
    68
		EBURRestoreFull    = 0x00000008, /*!< 0x00000008: The device as a whole is engaged in a restore of all components data */
williamr@2
    69
		EBURRestorePartial = 0x00000010  /*!< 0x00000010: The device as a whole is engaged in a restore of all components data */
williamr@2
    70
		};
williamr@2
    71
williamr@2
    72
	/** TBackupIncType Bitmask
williamr@2
    73
	@released
williamr@2
    74
	@publishedAll
williamr@2
    75
	*/
williamr@2
    76
	const TUint KBackupIncTypeMask = 0xffffff00;
williamr@2
    77
williamr@2
    78
	enum TBackupIncType
williamr@2
    79
		/** 
williamr@2
    80
		The type of a backup.
williamr@2
    81
williamr@2
    82
		@released
williamr@2
    83
		@publishedAll
williamr@2
    84
		*/
williamr@2
    85
		{
williamr@2
    86
		ENoBackup        = 0x00000000, /*!< 0x00000000: No backup is in progress */
williamr@2
    87
		EBackupBase      = 0x00000100, /*!< 0x00000100: The backup is a base backup, i.e. it includes all files / data */
williamr@2
    88
		EBackupIncrement = 0x00000200  /*!< 0x00000200: The backup is an incremental backup, i.e. it includes only files / data that have changed since a previous backup */
williamr@2
    89
		};
williamr@2
    90
williamr@2
    91
	} // end namespace
williamr@2
    92
#endif