104 Note: The free page threshold data member of the callback is in Kb. |
104 Note: The free page threshold data member of the callback is in Kb. |
105 The function implementation will convert that threshold to pages and pass it to the OS porting layer. |
105 The function implementation will convert that threshold to pages and pass it to the OS porting layer. |
106 |
106 |
107 @param aFullName The full database name, including the path. |
107 @param aFullName The full database name, including the path. |
108 @param aFreePageCallback Input/Output parameter. A reference to an object containing the free pages threshold and |
108 @param aFreePageCallback Input/Output parameter. A reference to an object containing the free pages threshold and |
109 the callback that needs to be called when the free page count reaches ot is above the threshold. |
109 the callback that needs to be called when the free page count reaches or is above the threshold. |
110 aFreePageCallback.iThreshold must be set to be in Kb. |
110 aFreePageCallback.iThreshold must be set to be in Kb. |
111 If the function call completes successfully and the free pages space is above the threshold, |
111 If the function call completes successfully and the free pages space is above the threshold, |
112 the aFreePageCallback.iThreshold will be set to contain the free pages count. |
112 the aFreePageCallback.iThreshold will be set to contain the free pages count. |
113 Otherwise aFreePageCallback.iThreshold will be initizized with zero. |
113 Otherwise aFreePageCallback.iThreshold will be initialized with zero. |
114 |
114 |
115 @leave KErrNoMemory, an out of memory condition has occurred, |
115 @leave KErrNoMemory, an out of memory condition has occurred, |
116 KErrArgument, invalid data in the aFreePageCallback object; |
116 KErrArgument, invalid data in the aFreePageCallback object; |
117 Note that the function may also leave with some other database specific |
117 Note that the function may also leave with some other database specific |
118 errors categorised as ESqlDbError, and other system-wide error codes. |
118 errors categorised as ESqlDbError, and other system-wide error codes. |
197 /** |
197 /** |
198 A factory function for CSqlCompactConn. |
198 A factory function for CSqlCompactConn. |
199 |
199 |
200 @param aFullName The full name of the database to be compacted (including the path). |
200 @param aFullName The full name of the database to be compacted (including the path). |
201 @param aFreePageCallback A reference to an object containing the free pages threshold and the callback |
201 @param aFreePageCallback A reference to an object containing the free pages threshold and the callback |
202 that needs to be called when the free page count reaches ot is above the threshold. |
202 that needs to be called when the free page count reaches or is above the threshold. |
203 aFreePageCallback.iThreshold must be set to be in Kb. |
203 aFreePageCallback.iThreshold must be set to be in Kb. |
204 If the function call completes successfully and the free pages space is above the threshold, |
204 If the function call completes successfully and the free pages space is above the threshold, |
205 the aFreePageCallback.iThreshold will be set to contain the free pages count. |
205 the aFreePageCallback.iThreshold will be set to contain the free pages count. |
206 Otherwise aFreePageCallback.iThreshold will be initizized with zero. |
206 Otherwise aFreePageCallback.iThreshold will be initialized with zero. |
207 |
207 |
208 @return A pointer to the created MSqlCompactConn interface. |
208 @return A pointer to the created MSqlCompactConn interface. |
209 |
209 |
210 @leave KErrNoMemory, an out of memory condition has occurred, |
210 @leave KErrNoMemory, an out of memory condition has occurred, |
211 KErrArgument, invalid data in the aFreePageCallback object; |
211 KErrArgument, invalid data in the aFreePageCallback object; |