Sets the currently indexed recipient. This property is not available at design time.
Syntax
object.RecipIndex [ = value ]
The RecipIndex property syntax these parts:
| Part | Description |
| object | An object expression that evaluates to an object in the Applies To list. |
| value | A long expression specifying the currently indexed recipient. |
Remarks
Specifies an index number to identify a particular message recipient. The index number in this property determines the values in the RecipAddress, RecipCount, RecipDisplayName, and RecipType properties.
The recipient identified by the RecipIndex property is called the currently indexed recipient. The value of RecipIndex can range from 0 (the default) to RecipCount -1. When in the read buffer with RecipIndex set to -1, values of the other recipient properties show message originator information. The default setting is 0.
To add a new recipient, set the RecipIndex to a value greater than or equal to the current recipient count while in the compose buffer. The RecipCount property is updated automatically to reflect the implied new number of recipients. For example, if the current RecipCount property has the value 3, setting the RecipIndex property to 4 adds 2 new recipients and increases the RecipCount property to 5.
To delete an existing recipient, specify the Delete method with the value parameter set to 1. Recipients can be added or deleted only when the MsgIndex property is set to -1.
Data Type
Long