InsertFolderItem method: Favorite collection

Syntax

InsertFolderItem(FavoriteLabel, FavoriteName)

Description

Use the InsertFolderItem method to insert the Favorite folder object identified by FavoriteName into the Favorite collection.

Note:

The portal registry classes execute some methods "interactively", that is, as they happen. The item won't be marked for insertion, then actually inserted later. The item is inserted to the database as soon as the method is executed.

Parameters

Parameter	Description
FavoriteLabel	Specify a label for the new Favorite folder as a string. This is the text by which the favorite is identified to the end user.
FavoriteName	Specify the name for the new Favorite folder as a string. If you specify a name that already exists in the collection, you get an error.

Returns

A reference to the new Favorite object if the method executes successfully, Null otherwise.