Platform SDK: CDO 1.2.1

Delete Method (Folder Object)

The Delete method removes the Folder object from its parent Folders collection or InfoStore object.

Syntax

objFolder.Delete( )

Remarks

The Delete method performs an irreversible operation on the collection. It calls Release on the collection's reference to the Folder object. If you have another reference to the folder, you can still access its properties and methods, but you can never again associate it with any collection because the Add method always creates a new object. You should Set your reference variable either to Nothing or to another folder.

The final Release on the Folder object takes place when you assign your reference variable to Nothing, or when you call Delete if you had no other reference. At this point the object is removed from memory. Attempted access to a released object results in an error return of CdoE_INVALID_OBJECT.

The action of the Delete method is permanent, and the Folder object cannot be restored to the collection. Before calling Delete, your application can prompt the user to verify whether the folder should be permanently deleted.

When you delete a member of a collection, the collection is immediately refreshed, meaning that its Count property is reduced by one and its members are reindexed. To access a member following the deleted member, you must use its new index value. For more information, see Looping Through a Collection.

You can delete all the folders in the Folders collection by calling the collection's Delete method. The ability to delete any folder depends on the permissions granted to the user. The Delete method returns an error code if called with insufficient permissions.

Example

This code fragment illustrates the two situations previously explained. The Set statement calls AddRef on the first child Folder object. That reference survives the call to Delete and has to be reassigned. The second child Folder object is deleted without creating another reference, and no other action is necessary.

' assume valid Folder object 
Set objChildFolder = objFolder.Folders.Item(1) 
objChildFolder.Delete ' still have a reference from Set statement 
' ... other operations on objChildFolder possible but pointless ... 
Set objChildFolder = Nothing ' necessary to remove reference 
' ... 
objFolder.Folders.Item(2).Delete ' no reference to remove