| Platform SDK: CDO 1.2.1 |
The Delete method removes the Format object from the Formats collection.
objFormat.Delete( )
The Delete method performs an irreversible operation on the collection. It calls Release on the collection’s reference to the Format object. If you have another reference to the format, 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 format.
The final Release on the Format 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 Format object cannot be restored to the collection. Before calling Delete, your application can prompt the user to verify whether the format 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.
This code fragment illustrates the two situations previously explained. The Set statement calls AddRef on the first Format object. That reference survives the call to Delete and has to be reassigned. The second Format object is deleted without creating another reference, and no other action is necessary.
' assume valid ObjectRenderer object Set objFormat = objObjectRenderer.Formats.Item(1) objFormat.Delete ' still have a reference from Set statement ' ... other operations on objFormat possible but pointless ... Set objFormat = Nothing ' necessary to remove reference ' ... objObjectRenderer.Formats.Item(2).Delete ' no reference to remove