StoreIndex Property  
 

Gets and sets the current message index for the current storage file.

Syntax

object.StoreIndex [= value ]

Remarks

The StoreIndex property returns the current message index for the message store. Setting this property changes the current message index. When no storage file has been opened, this property will return a value of zero. After a storage file has been opened, it is changed to a value of one, the first message in the message store. The maximum value for this property is the number of messages in the store, as returned by the StoreSize property. Attempting to set this property to a value less than one or greater than the number of messages in the store will result in an exception being thrown.

This property value is updated whenever the ReadStore or ReplaceMessage methods are used. When the WriteStore method is used to store the current message in the message store, this property will be updated to reflect the message index of the newly added message.

Data Type

Integer (Int32)

See Also

StoreCount Property, StoreFile Property, StoreSize Property, FindMessage Method, ReadStore Method, WriteStore Method