Strings::Join Method (array<String^>^, String^)

 

Returns a string created by joining a number of substrings contained in an array.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public:
static String^ Join(
	array<String^>^ SourceArray,
	String^ Delimiter = ""
)

Parameters

SourceArray
Type: array<System::String^>^

Required. One-dimensional array containing substrings to be joined.

Delimiter
Type: System::String^

Optional. Any string, used to separate the substrings in the returned string. If omitted, the space character (" ") is used. If Delimiter is a zero-length string ("") or Nothing, all items in the list are concatenated with no delimiters.

Return Value

Type: System::String^

Returns a string created by joining a number of substrings contained in an array.

Exception Condition
ArgumentException

SourceArray is not one dimensional.

There is a parity between the Join and Split functions. The Join function takes an array of strings and joins them using a delimiter string, to return a single string. The Split function takes a string and separates it at the delimiter, to return an array of strings. However, a key difference is that Join can concatenate strings with any delimiter string, Split can only separate strings using a single character delimiter.

The following example demonstrates how to use the Join function to create a list from several strings.

Dim TestItem() As String = {"Pickle", "Pineapple", "Papaya"}
' Returns "Pickle, Pineapple, Papaya"
Dim TestShoppingList As String = Join(TestItem, ", ")

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show: