Add Method

Description

Add a string to the collection

Syntax

Visual Basic
Public Sub Add( _ ByVal Item As String, _ Optional ByVal Index As Long = 0 _ )

Parameters

Item: What is added to the collection.
Index: Optional. Defaults to the end of the collection. Specifies where in the collection the string should be inserted. If multiple substrings are added, then they will start at this index. Should be at least 1 and no greater than 1 more than the Count property.

Remarks

Item is parsed for the Delimiter, and is segmented into substrings if found. All substrings are added as individual strings to the collection.

For example, if the Delimiter is ":" and Item is "ab:cd:ef", then "ab", "cd", and "ef" are added.

The Add method takes linear (O(n)) time, where n is the number of delimited strings being added.

This method may generate the following error code (refer to MailErrorConstants for a complete list of error codes):

mailInvalidParam2 (Index is greater than Count + 1.) Note: Index of 0 will add to the end of the collection, as if no Index was specified.