sl@0: // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #include "centralrepository.h"
sl@0: #include "heaprepos.h"
sl@0: #include "datatype.h"
sl@0: #include "pccenrepimpl.h"
sl@0: 
sl@0: /** Creates a CRepository object for accessing a repository.
sl@0: If there is no such repository, the function leaves with KErrNotFound.
sl@0: A pointer to the object is left on the cleanup stack.
sl@0: @param aRepositoryUid The UID of the repository to be accessed
sl@0: @return A pointer to a newly created CRepository object
sl@0: @capability None
sl@0: */
sl@0: EXPORT_C CRepository* CRepository::NewLC(TUid aRepositoryUid)
sl@0: 	{
sl@0: 	CRepository* self=new (ELeave)CRepository();
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aRepositoryUid,KNullDesC,KNullDesC,ETrue);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Creates a CRepository object for accessing a repository.
sl@0: If there is no such repository, the function leaves with KErrNotFound.
sl@0: @param aRepositoryUid The UID of the repository to be accessed
sl@0: @return A pointer to a newly created CRepository object
sl@0: @capability None
sl@0: */
sl@0: EXPORT_C CRepository* CRepository::NewL(TUid aRepositoryUid)
sl@0: 	{
sl@0: 	CRepository* self=CRepository::NewLC(aRepositoryUid);
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Creates a CRepository object for accessing a repository specified in the input file
sl@0: @param aInputFileName the location of the input file it should be in the format <file_path><XXXXXXXX><.txt/.cre> where XXXXXXXX is a 32 bit hex number
sl@0: @param aOutputFileName the location fo the output it should be in the format <file_path><XXXXXXXX><.cre> where XXXXXXX is a 32 bit hex number
sl@0: @leave KErrArgument if the file specified in the input and output do not follow the specification above
sl@0: 	 KErrCorrupt if the input file is corrupted
sl@0:    	 KErrNoMemory if run out of memory
sl@0: */
sl@0: EXPORT_C CRepository* CRepository::NewL(const TDesC& aInputRepositoryFile,const TDesC& aOutputRepositoryFile)	
sl@0: 	{
sl@0: 	CRepository* self=CRepository::NewLC(aInputRepositoryFile,aOutputRepositoryFile);
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;		
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Creates a CRepository object for accessing a repository specified in the input file.
sl@0: A pointer to the object is left on the cleanup stack.
sl@0: @param aInputFileName the location of the input file it should be in the format <file_path><XXXXXXXX><.txt/.cre> where XXXXXXXX is a 32 bit hex number
sl@0: @param aOutputFileName the location fo the output it should be in the format <file_path><XXXXXXXX><.cre> where XXXXXXX is a 32 bit hex number
sl@0: @leave KErrArgument if the file specified in the input and output do not follow the specification above
sl@0: 	 KErrCorrupt if the input file is corrupted
sl@0:    	 KErrNoMemory if run out of memory
sl@0: */
sl@0: EXPORT_C CRepository* CRepository::NewLC(const TDesC& aInputRepositoryFile,const TDesC& aOutputRepositoryFile)
sl@0: 	{
sl@0: 	CRepository* self=new (ELeave)CRepository();
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(KNullUid,aInputRepositoryFile,aOutputRepositoryFile,EFalse);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: void CRepository::ConstructL(TUid aRepositoryUid,const TDesC& aInFileName,const TDesC& aOutFileName,TBool aAutoLoading)
sl@0: 	{
sl@0: 	iImpl = CPcRepImpl::NewL(aRepositoryUid,aInFileName,aOutFileName,aAutoLoading);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Flush any content of the repository in the heap to physical file, the target file is either the explicitly
sl@0: specified output file or the implicitly determined output file depending on which NewL function is used
sl@0: to construct the repository
sl@0: @return KErrNone if successful,
sl@0: 	plus other system-wide error codes.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Flush()
sl@0: 	{
sl@0: 	return iImpl->Flush();
sl@0: 	}
sl@0: 
sl@0: /** Destructor. 
sl@0: @capability None
sl@0: */
sl@0: EXPORT_C CRepository::~CRepository()
sl@0: 	{
sl@0: 	delete iImpl;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Creates a new setting with an integer value.
sl@0: @param aKey New setting key.
sl@0: @param aValue Setting value.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrAlreadyExists if a setting with that key already exists
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions.
sl@0: 	Outside transactions: on success the new setting is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Create(TUint32 aKey, TInt aValue)
sl@0: 	{
sl@0: 	TRAPD(err,iImpl->CreateSettingL(aKey,aValue,NULL));
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Creates a new setting with a floating-point value.
sl@0: @param aKey New setting key.
sl@0: @param aValue Setting value.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrAlreadyExists if a setting with that key already exists
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions.
sl@0: 	Outside transactions: on success the new setting is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Create(TUint32 aKey, const TReal& aValue)
sl@0: 	{
sl@0: 	TRAPD(err,iImpl->CreateSettingL(aKey,aValue,NULL));
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Creates a new setting with a descriptor value.
sl@0: @param aKey New setting key.
sl@0: @param aValue Setting value.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrAlreadyExists if a setting with that key already exists
sl@0: 	KErrArgument if the descriptor is longer than KMaxBinaryLength,
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions.
sl@0: 	Outside transactions: on success the new setting is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Create(TUint32 aKey, const TDesC8& aValue)
sl@0: 	{
sl@0: 	if (aValue.Length()>KMaxBinaryLength)
sl@0: 		return KErrArgument;	
sl@0: 	TRAPD(err,iImpl->CreateSettingL(aKey,aValue,NULL));
sl@0: 	return err;	
sl@0: 	}
sl@0: 
sl@0: /** Creates a new setting with a descriptor value.
sl@0: @param aKey New setting key.
sl@0: @param aValue Setting value.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrAlreadyExists if a setting with that key already exists
sl@0: 	KErrArgument if the descriptor is longer than KMaxUnicodeStringLength,
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions.
sl@0: 	Outside transactions: on success the new setting is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Create(TUint32 aKey, const TDesC16& aValue)
sl@0: 	{
sl@0: 	if (aValue.Length()>KMaxUnicodeStringLength)
sl@0: 		return KErrArgument;
sl@0: 	TPtrC8 pVal((const TUint8*)aValue.Ptr(), aValue.Length()*2);		
sl@0: 	return Create(aKey,pVal);
sl@0: 	}
sl@0: 
sl@0: /** Deletes a setting.
sl@0: @param aKey Key of setting to be deleted.
sl@0: @return
sl@0: 	KErrNone if successful, 
sl@0: 	KErrNotFound if the setting does not exist,
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions except KErrNotFound.
sl@0: 	Outside transactions: on success the deletion of the setting is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy for that key in the repository
sl@0: */
sl@0: EXPORT_C TInt CRepository::Delete(TUint32 aKey)
sl@0: 	{
sl@0: 	TRAPD(err,iImpl->DeleteSettingL(aKey));
sl@0: 	iImpl->RemoveAnyMarkDeleted();
sl@0: 	return err;
sl@0: 	}
sl@0: 	
sl@0: /** Deletes all the settings that exist and match the specification:
sl@0: 	(key & mask) == (partialKey & mask)
sl@0: Partial key is guaranteed to be masked before use.
sl@0: Examples of use:
sl@0: - To delete a single key.
sl@0: 	Delete(key, 0xFFFFFFFF, errorKey);
sl@0: - To delete all keys from 0 to 0xFF:
sl@0: 	Delete(0, 0xFFFFFF00, errorKey);
sl@0: 	(digits from 0 to 0xFF would be ignored if given in the partial key)
sl@0: - To delete all keys matching 0x5B??3A?6:
sl@0: 	Delete(0x5B003A06, 0xFF00FF0F, errorKey);
sl@0: 
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the keys being deleted.
sl@0: @param aErrorKey If the delete operation fails this contains the key involved in the
sl@0: 	failure, or aPartialKey or KUnspecifiedKey if it could not be attributed to any key
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if no items were found in the partial key range.
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions except KErrNotFound
sl@0: 	Outside transactions: on success the changes are persistent, on failure the
sl@0: 	repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write policies of all settings found in the
sl@0: 					  partial key range.
sl@0: */	
sl@0: EXPORT_C TInt CRepository::Delete(TUint32 aPartialKey, TUint32 aMask, TUint32& aErrorKey)
sl@0: 	{
sl@0: 	TRAPD(ret,iImpl->DeleteRangeL(aPartialKey,aMask,aErrorKey));
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Reads an integer setting.
sl@0: @param aKey Key of setting to be read.
sl@0: @param aValue Returns the value of the setting if it is an integer.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if the setting does not exist,
sl@0: 	KErrArgument if the setting exists but is not an integer,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Get(TUint32 aKey, TInt& aValue)
sl@0: 	{
sl@0: 	return iImpl->Get(aKey,aValue);
sl@0: 	}
sl@0: 
sl@0: /** Reads a floating point setting.
sl@0: @param aKey Key of setting to be read.
sl@0: @param aValue Returns the value of the setting if it is a floating point value.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if the setting does not exist,
sl@0: 	KErrArgument if the setting exists but is not a floating point value,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Get(TUint32 aKey, TReal& aValue)
sl@0: 	{
sl@0: 	return iImpl->Get(aKey,aValue);
sl@0: 	}
sl@0: 	
sl@0: /** Reads a descriptor setting.
sl@0: @param aKey Key of setting to be read.
sl@0: @param aValue Returns the value of the setting if it is a descriptor.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if the setting does not exist,
sl@0: 	KErrArgument if the setting exists but is not a descriptor,
sl@0: 	KErrOverflow if the descriptor is too small to receive the value in the repository,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Get(TUint32 aKey, TDes8& aValue)
sl@0: 	{
sl@0: 	TInt actual;
sl@0: 	return Get(aKey,aValue,actual);
sl@0: 	}
sl@0: 
sl@0: /** Reads a descriptor setting.
sl@0: @param aKey Key of setting to be read.
sl@0: @param aValue Returns the value of the setting if it is a descriptor.
sl@0: @param aActualLength Returns the actual length of the setting if it is a descriptor.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if the setting does not exist,
sl@0: 	KErrArgument if the setting exists but is not a descriptor,
sl@0: 	KErrOverflow if the descriptor is too small to receive the value in the repository,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Get(TUint32 aKey, TDes8& aValue, TInt& aActualLength)
sl@0: 	{
sl@0: 	TBuf8<KMaxBinaryLength> val;
sl@0: 	TInt ret = iImpl->Get(aKey, val);	
sl@0: 	if (ret==KErrNone)
sl@0: 		{
sl@0: 		TInt settingValueLength=val.Length();
sl@0: 		//now check whether any string overflow
sl@0: 		if (settingValueLength > aValue.MaxLength())
sl@0: 			{
sl@0: 			aActualLength=settingValueLength;
sl@0: 			aValue.Copy(val.Left(aValue.MaxLength()));
sl@0: 			return KErrOverflow;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			aValue.Copy(val);
sl@0: 			}
sl@0: 		}	
sl@0: 	return ret;	
sl@0: 	}
sl@0: 
sl@0: /** Reads a descriptor setting.
sl@0: @param aKey Key of setting to be read.
sl@0: @param aValue Returns the value of the setting if it is a descriptor.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if the setting does not exist,
sl@0: 	KErrArgument if the setting exists but is not a descriptor,
sl@0: 	KErrOverflow if the descriptor is too small to receive the value in the repository,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Get(TUint32 aKey, TDes16& aValue)
sl@0: 	{
sl@0: 	TPtr8 ptr8((TUint8*)aValue.Ptr(), 0, aValue.MaxSize());
sl@0: 	TInt ret=Get(aKey,ptr8);
sl@0: 	if (ret==KErrNone)
sl@0: 		aValue.SetLength(ptr8.Length()/2);
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: /** Reads a descriptor setting.
sl@0: @param aKey Key of setting to be read.
sl@0: @param aValue Returns the value of the setting if it is a descriptor.
sl@0: @param aActualLength Returns the actual length of the setting if it is a descriptor.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if the setting does not exist,
sl@0: 	KErrArgument if the setting exists but is not a descriptor,
sl@0: 	KErrOverflow if the descriptor is too small to receive the value in the repository,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Get(TUint32 aKey, TDes16& aValue, TInt& aActualLength)
sl@0: 	{
sl@0: 	TInt actualLength8;
sl@0: 	TPtr8 ptr8((TUint8*)aValue.Ptr(), 0, aValue.MaxSize());
sl@0: 	TInt ret=Get(aKey,ptr8,actualLength8);
sl@0: 	aValue.SetLength(ptr8.Length()/2);			
sl@0: 	aActualLength=actualLength8/2;		
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: /** Sets an existing integer setting to a new value or creates a new setting 
sl@0: with an integer value if the setting doesn't exist.
sl@0: @param aKey Key of setting to be written to.
sl@0: @param aValue Value to be written.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrArgument if the setting exists but is not an integer
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions.
sl@0: 	Outside transactions: on success the new value is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Set(TUint32 aKey, TInt aValue)
sl@0: 	{
sl@0: 	TRAPD(err,iImpl->SetSettingL(aKey,aValue));
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /** Sets an existing floating point setting to a new value or creates a new setting
sl@0: with a floating point value if the setting doesn't exist.
sl@0: @param aKey Key of setting to be written to.
sl@0: @param aValue Value to be written.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrArgument if the setting exists but is not a floating point value
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions.
sl@0: 	Outside transactions: on success the new value is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Set(TUint32 aKey, const TReal& aValue)
sl@0: 	{
sl@0: 	TRAPD(err,iImpl->SetSettingL(aKey,aValue));
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /** Sets an existing descriptor setting to a new value or creates a new setting
sl@0: with a descriptor value if the setting doesn't exist.
sl@0: @param aKey Key of setting to be written to.
sl@0: @param aValue Value to be written.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrArgument if aValue is longer than KMaxBinaryLength or
sl@0: 	the setting exists but is not a descriptor,
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions.
sl@0: 	Outside transactions: on success the new value is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Set(TUint32 aKey, const TDesC8& aValue)
sl@0: 	{
sl@0: 	if (aValue.Length()>KMaxBinaryLength)
sl@0: 		return KErrArgument;
sl@0: 	TRAPD(err,iImpl->SetSettingL(aKey,aValue));
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /** Sets an existing descriptor setting to a new value or creates a new setting
sl@0: with a descriptor value if it doesn't exist.
sl@0: @param aKey Key of setting to be written to.
sl@0: @param aValue Value to be written.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrArgument if aValue is longer than KMaxUnicodeStringLength or
sl@0: 	the setting exists but is not a descriptor,
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions.
sl@0: 	Outside transactions: on success the new value is persistent,
sl@0: 	on failure the repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the write access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Set(TUint32 aKey, const TDesC16& aValue)
sl@0: 	{
sl@0: 	if (aValue.Length()>KMaxUnicodeStringLength)
sl@0: 		return KErrArgument;	
sl@0: 	TPtrC8 pVal((const TUint8*)aValue.Ptr(), aValue.Length()*2);
sl@0: 	return Set(aKey,pVal);
sl@0: 	}
sl@0: 
sl@0: /** Reads the metadata bound to a key
sl@0: @param aKey The key
sl@0: @param aMeta Returns the metadata value for the key
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if the setting does not exist,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read access policy of that key in the repository.
sl@0: */
sl@0: EXPORT_C TInt CRepository::GetMeta(TUint32 aKey, TUint32& aMeta)
sl@0: 	{
sl@0: 	return iImpl->GetMeta(aKey,aMeta);	
sl@0: 	}
sl@0: 
sl@0: /** Moves all the settings that exist and match the specification:
sl@0: 	(oldkey & mask) == (sourcePartialKey & mask)
sl@0: to new locations where 
sl@0: 	(newkey & mask) == (targetPartialKey & mask).
sl@0: For those keys that match the source specification, those bits in the key for
sl@0: which the corresponding mask bit is zero remain unchanged. All remaining bits
sl@0: change from (sourcePartialKey & mask) to (targetPartialKey & mask).
sl@0: Both partial keys are guaranteed to be masked before use.
sl@0: Examples of use:
sl@0: - To move a single key from oldKey to newKey.
sl@0: 	Move(oldKey, newKey, 0xFFFFFFFF, errorKey);
sl@0: - To move all keys from 0 to 0xFF to be from 0x100 to 0x1FF:
sl@0: 	Move(0, 0x100, 0xFFFFFF00, errorKey);
sl@0: 	(digits from 0 to 0xFF would be ignored if given in the partial keys)
sl@0: - To move all keys matching 0x5B??3A?6 to 0xDC??44?F:
sl@0: 	Move(0x5B003A06, 0xDC00440F, 0xFF00FF0F, errorKey);
sl@0: 
sl@0: @param aSourcePartialKey
sl@0: 	Contains a bit pattern that all the source keys which must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the keys being moved.
sl@0: @param aTargetPartialKey
sl@0: 	Contains a bit pattern that all the target keys which must at least partially
sl@0: 	match.	
sl@0: @param aErrorKey on failure, contains the key or partial key involved in the error
sl@0: 	or KUnspecifiedKey if failure could not be attributed to any key.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if no items were found in the source range.
sl@0: 	KErrAlreadyExists if an existing setting is using any intended target key.
sl@0: 	plus other system-wide error codes.
sl@0: @post
sl@0: 	Transactions fail on all error conditions except KErrNotFound.
sl@0: 	Outside transactions: on success the changes are persistent, on failure the
sl@0: 	repository is unmodified.
sl@0: @capability Dependent Caller must satisfy the read and write policies of all settings found in the
sl@0: 					  source range, and write policies on all intended target keys.
sl@0: */
sl@0: EXPORT_C TInt CRepository::Move (TUint32 aSourcePartialKey, TUint32 aTargetPartialKey, 
sl@0: 								 TUint32 aMask, TUint32& aErrorKey)
sl@0: 	{
sl@0: 	TRAPD(ret,iImpl->MoveL(aSourcePartialKey,aTargetPartialKey,aMask,aErrorKey));
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: /** Finds all the settings that exist and match the specification given by
sl@0: aPartialKey and aMask.
sl@0: Matches occur whenever (key & mask) == (partialKey & mask).
sl@0: The partial key is guaranteed to be masked before use.
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aFoundKeys All the keys found.
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if no items were found in the source range,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	RArray<TUint32> dummy;
sl@0: 	TRAPD(ret,iImpl->FindL(aPartialKey,aMask,aFoundKeys,KMaximumKey,dummy));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Finds all the settings that contain a given integer and match the
sl@0: specification given by aPartialKey and aMask.
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aValue Settings for the keys found will be integers with value aValue.
sl@0: @param aFoundKeys All the keys found.
sl@0: 	For each key k in aFoundKeys, (k & aMask) == (aPartialKey & aMask) and
sl@0: 	the setting with key k is an integer aValue.
sl@0: @see FindL()
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if capability check passed but no matching items are found,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read policies of all settings found in the source range.
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindEqL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	TInt aValue, RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	TRAPD(ret,iImpl->FindSettingsComparisonL(aPartialKey,aMask,aValue,EEqual,aFoundKeys));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Finds all the settings that contain a given floating point value and match
sl@0: the specification given by aPartialKey and aMask.
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aValue
sl@0: 	Settings for the keys found will be floating point values with value aValue.
sl@0: @param aFoundKeys All the keys found.
sl@0: 	For each key k in aFoundKeys, (k & aMask) == (aPartialKey & aMask) and
sl@0: 	the setting with key k is a floating point value aValue.
sl@0: @see FindL()
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if capability check passed but no matching items are found,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read policies of all settings found in the source range.
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindEqL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	const TReal& aValue, RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	TRAPD(ret,iImpl->FindSettingsComparisonL(aPartialKey,aMask,aValue,EEqual,aFoundKeys));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Finds all the settings that contain a given string value and match the
sl@0: specification given by aPartialKey and aMask.
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aValue
sl@0: 	Settings for the keys found will be string values with value aValue.
sl@0: @param aFoundKeys All the keys found.
sl@0: 	For each key k in aFoundKeys, (k & aMask) == (aPartialKey & aMask) and
sl@0: 	the setting with key k is a string value aValue.
sl@0: @see FindL()
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if capability check passed but no matching items are found,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read policies of all settings found in the source range.
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindEqL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	const TDesC8& aValue, RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	TRAPD(ret,iImpl->FindSettingsComparisonL(aPartialKey,aMask,aValue,EEqual,aFoundKeys));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Finds all the settings that contain a given string value and match the
sl@0: specification given by aPartialKey and aMask.
sl@0: 
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aValue
sl@0: 	Settings for the keys found will be string values with value aValue.
sl@0: @param aFoundKeys All the keys found.
sl@0: 	For each key k in aFoundKeys, (k & aMask) == (aPartialKey & aMask) and
sl@0: 	the setting with key k is a string value aValue.
sl@0: @see FindL()
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if capability check passed but no matching items are found,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read policies of all settings found in the source range.
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindEqL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	const TDesC16& aValue, RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	TPtrC8 pVal((const TUint8*)aValue.Ptr(), aValue.Length()*2);	
sl@0: 	TRAPD(ret,iImpl->FindSettingsComparisonL(aPartialKey,aMask,pVal,EEqual,aFoundKeys));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Finds all the settings that match the specification given by aPartialKey
sl@0: and aMask, but are either not integer values or do not have the given value.
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aValue
sl@0: 	Settings for the keys found will be settings that either contain values
sl@0: 	that are not integers or integers other than aValue.
sl@0: @param aFoundKeys All the keys found.
sl@0: 	For each key k in aFoundKeys, (k & aMask) == (aPartialKey & aMask) and
sl@0: 	the setting with key k is either not an integer or an integer not equal to
sl@0: 	aValue.
sl@0: @see FindL()
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if capability check passed but no non-matching items are found,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read policies of all settings found in the source range.
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindNeqL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	TInt aValue, RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	TRAPD(ret,iImpl->FindSettingsComparisonL(aPartialKey,aMask,aValue,ENotEqual,aFoundKeys));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Finds all the settings that match the specification given by aPartialKey
sl@0: and aMask, but are either not floating point values or do not have the given value.
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aValue
sl@0: 	Settings for the keys found will be settings that either contain values
sl@0: 	that are not floating point or floating point values other than aValue.
sl@0: @param aFoundKeys All the keys found.
sl@0: 	For each key k in aFoundKeys, (k & aMask) == (aPartialKey & aMask) and
sl@0: 	the setting with key k is either not a floating point value or a floating
sl@0: 	point value not equal to aValue.
sl@0: @see FindL()
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if capability check passed but no non-matching items are found,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read policies of all settings found in the source range.
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindNeqL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	const TReal& aValue, RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	TRAPD(ret,iImpl->FindSettingsComparisonL(aPartialKey,aMask,aValue,ENotEqual,aFoundKeys));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Finds all the settings that match the specification given by aPartialKey
sl@0: and aMask, but are either not string values or do not match the given string.
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aValue
sl@0: 	Settings for the keys found will be settings that either contain values
sl@0: 	that are not strings or strings with value other than aValue.
sl@0: @param aFoundKeys All the keys found.
sl@0: 	For each key k in aFoundKeys, (k & aMask) == (aPartialKey & aMask) and
sl@0: 	the setting with key k is either not a string value or a string value not
sl@0: 	equal to aValue.
sl@0: @see FindL()
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if capability check passed but no non-matching items are found,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read policies of all settings found in the source range.
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindNeqL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	const TDesC8& aValue, RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	TRAPD(ret,iImpl->FindSettingsComparisonL(aPartialKey,aMask,aValue,ENotEqual,aFoundKeys));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: /** Finds all the settings that match the specification given by aPartialKey
sl@0: and aMask, but are either not string values or do not match the given string.
sl@0: @param aPartialKey
sl@0: 	Contains a bit pattern that all the keys returned must at least partially
sl@0: 	match.
sl@0: @param aMask
sl@0: 	Has bits set for all the bits in aPartialKey that must match the returned
sl@0: 	keys.
sl@0: @param aValue
sl@0: 	Settings for the keys found will be settings that either contain values
sl@0: 	that are not strings or strings with value other than aValue.
sl@0: @param aFoundKeys All the keys found.
sl@0: 	For each key k in aFoundKeys, (k & aMask) == (aPartialKey & aMask) and
sl@0: 	the setting with key k is either not a string value or a string value not
sl@0: 	equal to aValue.
sl@0: @see FindL()
sl@0: @return
sl@0: 	KErrNone if successful,
sl@0: 	KErrNotFound if capability check passed but no non-matching items are found,
sl@0: 	plus other system-wide error codes.
sl@0: @post Transactions fail only on those "other system-wide error codes".
sl@0: @capability Dependent Caller must satisfy the read policies of all settings found in the source range.
sl@0: */
sl@0: EXPORT_C TInt CRepository::FindNeqL(TUint32 aPartialKey, TUint32 aMask,
sl@0: 	const TDesC16& aValue, RArray<TUint32>& aFoundKeys)
sl@0: 	{
sl@0: 	TPtrC8 pVal((const TUint8*)aValue.Ptr(), aValue.Length()*2);	
sl@0: 	TRAPD(ret,iImpl->FindSettingsComparisonL(aPartialKey,aMask,pVal,ENotEqual,aFoundKeys));
sl@0: 	if (ret==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: /** Attempts to starts a transaction in the given mode.
sl@0: This function is doing nothing and just return KErrNone
sl@0: @param aMode transaction mode: EConcurrentReadWriteTransaction (standard),
sl@0: 	EReadTransaction or EReadWriteTransaction.
sl@0: @return KErrNone
sl@0: @see CRepository::TTransactionMode
sl@0: */
sl@0: EXPORT_C TInt CRepository::StartTransaction(TTransactionMode /**aMode*/)
sl@0: 	{
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Attempts to starts a transaction in the given mode asynchronously
sl@0: This function does nothing
sl@0: @param aMode transaction mode: EConcurrentReadWriteTransaction (standard),
sl@0: 	EReadTransaction or EReadWriteTransaction.
sl@0: @see CRepository::TTransactionMode
sl@0: @param aStatus No effect on this parameter
sl@0: */
sl@0: EXPORT_C void CRepository::StartTransaction(TTransactionMode /**aMode*/, TRequestStatus& /**aStatus*/)
sl@0: 	{
sl@0: 	return;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Commits a transaction.
sl@0: This function does nothing and just return KErrNone
sl@0: @return KErrNone
sl@0: @param aKeyInfo no effect on this parameter
sl@0: */
sl@0: EXPORT_C TInt CRepository::CommitTransaction(TUint32& /**aKeyInfo*/)
sl@0: 	{
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Commits a transaction asynchronously
sl@0: This function does nothing
sl@0: @param aKeyInfo
sl@0: 	A descriptor to receive a TUint32 value, e.g. TTransactionKeyInfoBuf, which
sl@0: 	client must ensure remains in scope for the duration of the asynchronous request.
sl@0: 	No effect on this input parameter
sl@0: @see CRepository::TTransactionKeyInfoBuf
sl@0: @param aStatus Completion status of asynchronous request:
sl@0: 	No effect on this input parameter
sl@0: */
sl@0: EXPORT_C void CRepository::CommitTransaction(TDes8& /**aKeyInfo*/, TRequestStatus& /**aStatus*/)
sl@0: 	{
sl@0: 	return;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Cancels the current transaction with rollback
sl@0: This function does nothing
sl@0: */
sl@0: EXPORT_C void CRepository::CancelTransaction()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /** Sets the active transaction to a failed state
sl@0: This function does nothing
sl@0: */
sl@0: EXPORT_C void CRepository::FailTransaction()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /** Pushes onto the CleanupStack a TCleanupItem that calls CancelTransaction if
sl@0: activated by a Leave or PopAndDestroy.
sl@0: This function does nothing 
sl@0: */
sl@0: EXPORT_C void CRepository::CleanupCancelTransactionPushL()
sl@0: 	{
sl@0: 	CleanupStack::PushL(TCleanupItem(CPcRepImpl::FailTransactionCleanupOperation, this));	
sl@0: 	}
sl@0: 	
sl@0: /** Pushes onto the CleanupStack a TCleanupItem that calls FailTransaction if
sl@0: activated by a Leave or PopAndDestroy.
sl@0: This function does nothing
sl@0: */
sl@0: EXPORT_C void CRepository::CleanupFailTransactionPushL()
sl@0: 	{
sl@0: 	CleanupStack::PushL(TCleanupItem(CPcRepImpl::FailTransactionCleanupOperation, this));	
sl@0: 	}
sl@0: