Method

Join


Warning

This item was deprecated in version 2019r2. Please use String.FromArray as a replacement.

Description

Assigns a value to a String variable by concatenating the elements of a one-dimensional String array.

Usage

result = Join(sourceArray [,delimiter])

Part

Type

Description

result

String

String that results from concatenating all the elements of sourceArray, optionally separated by delimiter.

sourceArray

String array

Source array whose elements will be used to create result.

delimiter

String

Optional delimiter used in separating the elements of sourceArray when creating result. The default is one space.

Notes

Join takes a one-dimensional String array and concatenates the individual elements into a single String variable. You can pass an optional delimiter which will be inserted between the fields in the resulting String. If no delimiter is passed, a single space will be used as the delimiter.

The String.Split function performs the opposite function. It takes a String and creates an array by parsing the string into array elements using a specified delimiter.

Sample code

This example concatenates a three-element array into the string "Anthony,Aardvark,Accountant".

Dim names() As String = Array("Anthony", "Aardvark", "Accountant")
Dim combinedNames As String = Join(names, ",") ' returns "Anthony,Aardvark,Accountant"

Compatibility

All project types on all supported operating systems.

See also

Dim statement; Array, String, String, Arrays, Text, Text, functions; Arrays, Arrays.IndexOf, Arrays, Pop, Redim, Arrays, Shuffle, Sort, Sortwith methods; ParamArray keyword; Arrays concept