DeleteItem method: Favorite collection

Syntax

DeleteItem(FavoriteLabel)

Description

The DeleteItem method deletes the Favorite object identified by FavoriteLabel from the Favorite Collection.

Note:

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

Parameters

Parameter	Description
FavoriteLabel	Specify the label of a Favorite existing in the Favorite collection, that is, the text used to identify the favorite to the end-user.

Returns

A Boolean value: True if the Favorite was deleted, False otherwise.

Example

If Not &MyColl.DeleteItem("My Local Test") Then
   /* can't delete test data. Do error processing */
End-if;