|
|
Sets the value of an existing name-value pair in the message body.
Replaces the existing value with the new value. If there is more than one name=value pair with the specified name, the _index parameter will be required to select the correct value to modify. Because it is valid to have more than one pair with the same name and the same value, it is impossible to search for the orrect pair even if supplied with both the original name and the value. For that reason, there is no search method implemented that will return the index to use. It is up to the caller to track the order in which items are added. The first pair with a specific name will have an index of zero, the next pair with that same name to be added will have an index of 1, and so on. - Parameters:
-
| _name | name of the item for which we wish to set the value. |
| _value | new value for the pair. |
| _index | the value index. Optional parameter used when the name has more than one value associated with it (as with filters and groups, for example). Defaults to zero. |
- Returns:
- True if the name=value pair was added successfully.
- See also:
- AddValue, GetValue, GetMsgItem.
|
