ReadStore Method  
 

Retrieve a message from the message store, replacing the current message.

Syntax

object.ReadStore( MessageIndex )

Parameters

MessageIndex
An integer value which specifies the message that is to be removed from the message store. If this parameter is omitted, the current message as specified by the value of the StoreIndex property will be used.

Return Value

A value of zero is returned if the method succeeds. Otherwise, a non-zero error code is returned which indicates the cause of the failure.

Remarks

The ReadStore method reads the specified message from the message store, and the contents of that message will replace the current message. This method will update the current message index in the storage file.

See Also

StoreCount Property, StoreFile Property, StoreIndex Property, CloseStore Method, DeleteMessage Method, FindMessage Method, ReplaceMessage Method, WriteStore Method