GetPrevious Method (AddressEntries Collection)

GetPrevious Method (AddressEntries Collection)

The GetPrevious method returns the previous AddressEntry object in the AddressEntries collection. It returns Nothing if no previous object exists, for example if already positioned at the beginning of the collection.

Syntax

Set objAddressEntry = objAddrEntriesColl.GetPrevious( )

objAddressEntry

On successful return, represents the previous AddressEntry object in the collection.

objAddrEntriesColl

Required. The AddressEntries collection object.

Remarks

The order that items are returned by GetFirst, GetLast, GetNext, and GetPrevious depends on whether the address entries are sorted or not. The AddressEntry objects within a collection can be sorted on a MAPI property of your choice, either ascending or descending, using the Sort method. When the items are not sorted, you should not rely on these methods to return the items in any specified order. The best programming approach to use with unsorted collections is to assume that the access functions are able to access all items within the collection, but that the order of the objects is not defined.

If an AddressEntries collection has not been enumerated since it was initialized, the behavior of the GetPrevious method is not defined. A collection is enumerated when you call its GetFirst method, access a member through its Item property, or use its Filter property to specify a message filter. Some providers may return CdoE_CALL_FAILED if you call GetPrevious before the collection is enumerated.

Calling GetPrevious on an unenumerated collection can produce unexpected results if the collection is reinitialized with a Set statement in every iteration of a loop. The recommended procedure is to set an explicit variable for the collection before entering the loop. For more information, see Object Collections.

See Also

Concepts

AddressEntries Collection Object