persistentstorage/sql/SRC/Server/Compact/SqlCompact.h
branchRCL_3
changeset 9 667e88a979d7
parent 0 08ec8eefde2f
child 10 31a8f755b7fe
equal deleted inserted replaced
8:fa9941cf3867 9:667e88a979d7
     1 /**
     1 /**
     2 * Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
   116 @param aFullName The full name of the database to be compacted (including the path).
   116 @param aFullName The full name of the database to be compacted (including the path).
   117 @param aFreePageCallback Input/Output parameter. Object containing the free page callback parameters.
   117 @param aFreePageCallback Input/Output parameter. Object containing the free page callback parameters.
   118 						 aFreePageCallback.iThreshold must be set to be in Kb. 	
   118 						 aFreePageCallback.iThreshold must be set to be in Kb. 	
   119 						 If the function call completes successfully and the free pages space is above the threshold,
   119 						 If the function call completes successfully and the free pages space is above the threshold,
   120 						 the aFreePageCallback.iThreshold will be set to contain the free pages count.
   120 						 the aFreePageCallback.iThreshold will be set to contain the free pages count.
   121 						 Otherwise aFreePageCallback.iThreshold will be initizized with zero.
   121 						 Otherwise aFreePageCallback.iThreshold will be initialized with zero.
   122 
   122 
   123 @return A pointer to the created MSqlCompactConn interface.
   123 @return A pointer to the created MSqlCompactConn interface.
   124 
   124 
   125 @leave KErrNoMemory, an out of memory condition has occurred,
   125 @leave KErrNoMemory, an out of memory condition has occurred,
   126 	   KErrArgument, invalid data in the aFreePageCallback object;
   126 	   KErrArgument, invalid data in the aFreePageCallback object;