RFavouritesDb Class Reference

Add a new item to the database.

If successful, its Uid, Last-Mod-Time (and possibly its name) is updated on return.

Parameters:

	aItem	The item to add.
	aAutoRename	If this is ETrue, and the name already exists, the item will be renamed to a non-conflicting name.

Returns:

Error code, including:

• KErrArgument if the item's data is invalid (bad name, no URL, parent folder does not exist etc.).
• KErrAlreadyExists if the name is already in use in that folder.

Explicitly begin a transaction.

Parameters:

aWrite

Access mode.

Returns:

Error code.

Push a rollback on the cleanup stack.

Call this after Begin() call, to make the transaction leave-safe.

Returns:

void

Commit the transaction.

Returns:

Error code.

Perform databas synchronous compaction.

This function requires exclusive access to the database.

Returns:

Error code.

Count all items matching the supplied criteria.

Parameters:

	aCount	Placeholder for the returned item count. In case of any error, existing value is unchanged.
	aParentFolderFilter	Uid value to filter. KFavouritesNullUid clears (all accepted); this is the default.
	aTypeFilter	EItem or EFolder to use filter; ENone to clear filter (all accepted); this is the default.
	aNameFilter	Wildcard pattern to be used for name matching. NULL clears (all accepted); this is the default.
	aContextIdFilter	ContextId value to filter. KFavouritesNullContextId clears (all accepted); this is the default.

Returns:

Error code.

Create a folder with uid KFavouritesAdaptiveItemsFolderUid.

Owner is the caller. Uid, type (folder) and parent (root) is set, other properties are uninitialized. The Browser needs this. Note that this item does not exist in the database.

Returns:

The created item.

Create an empty item with uid KFavouritesStartPageUid.

Owner is the caller. Except its uid, the item is uninitialized. The Browser needs this. Note that this item does not exist in the database.

Returns:

The created item.

Delete item by Uid.

If this is a folder, all descendants and the contents of them are deleted. Homepage or root cannot be deleted.

Parameters:

aUid

Uid of item to delete.

Returns:

Error code, including:

• KErrNotFound if the item is not found.
• KErrAccessDenied if the item's cannot be deleted.

Delete file.

See RFavouritesFile.

Parameters:

aUid

Uid of the item.

Returns:

Errro code.

Check if the folder exists.

Parameters:

	aFolder	The folder to be checked.
	aFolderExists	Returned value.

Returns:

Error code.

Get the item with this Uid.

Parameters:

	aUid	Uid or item to get.
	aItem	placeholder for the returned item data.

Returns:

Error code.

Get all items matching the supplied criteria.

Parameters:

	aItemList	placeholder for the returned item data. Existing items remain (new ones appended).
	aParentFolderFilter	Uid value to filter. KFavouritesNullUid clears (all accepted); this is the default.
	aTypeFilter	EItem or EFolder to use filter; ENone to clear filter (all accepted); this is the default.
	aNameFilter	wildcard pattern to be used for name matching. NULL clears (all accepted); this is the default.
	aContextIdFilter	ContextId value to filter. KFavouritesNullContextId clears (all accepted); this is the default.

Returns:

Error code.

Get Browser associated with an item.

This data is for Browser's dedicated use, do not tamper.

Parameters:

	aUid	The uid of the item, to which the data belongs.
	aData	Data object, which receives the data.

Returns:

Error code, including:

• KErrNotFound No item is found with aUid.

Get data associated with an item.

Parameters:

	aUid	The uid of the item, to which the data belongs.
	aData	Data object, which receives the data.

Returns:

Error code, including:

• KErrNotFound No item is found with aUid.

Get uids of all items matching the supplied criteria.

Parameters:

	aUids	placeholder for the returned item data. Existing items remain (new ones appended).
	aParentFolderFilter	Uid value to filter. KFavouritesNullUid clears (all accepted); this is the default.
	aTypeFilter	EItem or EFolder to use filter; ENone to clear filter (all accepted); this is the default.
	aNameFilter	wildcard pattern to be used for name matching. NULL clears (all accepted); this is the default.
	aContextIdFilter	ContextId value to filter. KFavouritesNullContextId clears (all accepted); this is the default.

Returns:

Error code.

Check if the database to be recovered is fully functional.

Parameters:

aIsDamaged

Result is returned here.

Returns:

Error code.

Check if we already have this item.

Parameters:

	aUid	The item Uid to be checked.
	aItemExists	Returned value.

Returns:

Error code.

Check if aName is unique in its folder; and if not, change to an unique one, appending a number.

In case of any errors, aItem is unchanged. Names of special items (Start Page etc.) are not considered (can have conflicting names).

Parameters:

aItem

Item to set unique name for.

Returns:

Error code, including:

• KErrArgument aFolder is not found.
• KErrBadName Current name is empty.

Check if aName is unique in aFolder; and if not, change to an unique one, appending a number.

In case of any errors, aName is unchanged. Names of special items (Start Page etc.) are not considered (can have conflicting names).

Parameters:

	aName	Descriptor containing the original name and receiving the resulting unique name. Must be large enough to accomodate the result. (The appended text is KFavouritesMaxPostfix characters at most; the resulting length is KFavouritesMaxName at most.)
	aFolder	Folder to be used for uniqueness-checking.

Returns:

Error code, including:

• KErrArgument aFolder is not found.
• KErrBadName aName is empty.

Open the database.

Created if does not exist.

Parameters:

	aSess	Session to be used.
	aName	Database name.

Returns:

Error code.

Get preferred Uid for a folder.

Parameters:

	aFolder	Folder Uid.
	aPreferredUid	Uid of preferred item is returned here.

Returns:

Error code.

Perform database synchronous recovery.

This function requires exclusive access to the database.

Returns:

Error code.

User-level Restore Factory Settings operation.

Delete all items that has "factory item" flag set, then add new ones from reference database. In case of name conflilcts, new names are generated. Leaves on any error.

Parameters:

	aName	Database name.
	aReferenceDbPath	Full pathname of reference database.
	aApMapper	Access Point mapper to be used.

Roll back the transaction.

Returns:

void

Set Browser data associated with an item.

Any existing data, belonging to item having aUid, is now replaced. The item itself is not changed. This data is for Browser's dedicated use, do not tamper. In case of any errors, the data is not saved.

Parameters:

	aUid	The uid of the item, to which the data belongs.
	aData	Data) which replaces existing data.

Returns:

Error code, including:

• KErrNotFound No item is found with aUid.

Set data associated with an item.

Any existing data, belonging to item having aUid, is now replaced. The item itself is not changed. In case of any errors, the data is not saved.

Parameters:

	aUid	The uid of the item, to which the data belongs.
	aData	Data) which replaces existing data.

Returns:

Error code, including:

• KErrNotFound No item is found with aUid.

Set factory item flag on an item.

(Item with this flag set will be deleted if RFS is executed.)

Parameters:

	aUid	Uid of item.
	aFactoryItem	Flag value to set.

Returns:

Error code, including:

• KErrNotFound if the item is not found.

Update the Homepage item.

If does not exist, it is now created. The old Homepage, if any, is overwritten. If successful, its Uid and Last-Mod-Time is updated on return. Name needs not be unique.

Parameters:

aItem

Contents from this item (except Uid) will be used to update the Homepage Bookmark.

Returns:

Error code, including:

• KErrArgument if the supplied item is not item, or is not in the root folder.

Update the Last Visited.

If does not exist, it is now created. The old Last Visited, if any, is overwritten. If successful, its Uid is updated on return. Name needs not be unique.

Parameters:

aItem

Contents from this item (except Uid) will be used to update the Last Visited Item.

Returns:

Error code, including:

• KErrArgument if the supplied item is not item, or is not in the root folder.

Manual setting of Last Modification Time of an item.

Note that the Last Modification Time is automatically set by any edit, so this method need not be used in usual circumstances. It is provided for administration purposes only.

Parameters:

	aUid	Uid of item.
	aModified	Last Modification Time to set.

Returns:

Error code, including:

• KErrNotFound if the item is not found.

Set preferred Uid for a folder.

Parameters:

	aFolder	Folder Uid.
	aUid	Uid to be set as preferred. Not checked to exist in the folder.

Returns:

Error code, including:

• KErrNotFound if aFolder is not found;
• KErrArgument if aFolder is not a folder.

Set read-only flag on an item.

Parameters:

	aUid	Uid of item.
	aReadOnly	Flag value to set.

Returns:

Error code, including:

• KErrNotFound if the item is not found.

Get available database size.

Parameters:

aSize

Database size returned here.

Returns:

Error code.

Update an item.

Remember Homapage or Last Visited Page cannot be updated using this method.

Parameters:

	aItem	Contents from this item (except Uid) will be used to update the item. If successful, its Uid, Last-Mod-Time (and possibly its name) is updated on return.
	aUid	Update this item.
	aAutoRename	If this is ETrue, and the name already exists, the item will be renamed to a non-conflicting name.

Returns:

Error code, including:

• KErrNotFound if the item is not found.
• KErrArgument if the item's data is invalid (bad name, no URL, parent folder does not exist etc.).
• KErrAlreadyExists if the name is already in use in that folder.
• KErrAccessDenied for read-only items.

Update database statistics.

Returns:

Error code.

Get version information.

Returns:

Version object of this CFavouritesDb.