VB & VBA in a Nutshell: The Language

Join Function (VB6)

Named Arguments

No

Syntax

result = Join(sourcearray, [delimiter])

sourcearray

Use: Required

Data Type: String or Variant

Array whose elements are to be concatenated.

delimiter

Use: Optional

Data Type: String

Character used to delimit the individual values in the string.

Return Value

A String.

Description

Concatenates an array of values into a delimited string using a specified delimiter.

Rules at a Glance

• If no delimiter is specified, the space character is used as a delimiter.

• If you use numeric values in sourcearray, use a Variant array, don't specify a numeric data type for sourcearray ; otherwise, the function raises runtime error 5, "Invalid procedure call or argument."

• sourcearray can have any lower bound; that is, Join operates equally well with 0- or 1-based arrays.

• When a delimiter is specified, unused sourcearray elements are noted in the return string by the use of the delimiter. For example, if you specify a delimiter of "," and a source array with a lower bound of 1 and an upper bound of 10 in which only the first two elements are used, Join returns a string similar to the following:

  "a,b,,,,,,,,,"

Programming Tips and Gotchas

The Join function is ideal for quickly and efficiently writing out a comma-delimited text file from an array of values.