string.listChangeDelims()

Changes a list delimiter. Returns a copy of the list, with each delimiter character replaced by new_delimiter.

string.listChangeDelims( list, new_delimiter [, delimiters [, includeEmptyFields [, multiCharacterDelimiter ] ] ] )

Returns: String

Argument Description
list
string, required

a string list

new_delimiter
string, required

new delimiter to set. a delimiter is a characters that separate list elements.

delimiters
string, optional

existing delimiter to replace. a delimiter is a characters that separate list elements. The default value is comma.

includeEmptyFields
boolean, optional

if set to true, empty values are included as well

multiCharacterDelimiter
boolean, optional

specifying whether the delimiters parameter specifies a multi-character delimiter. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

Examples

There are currently no examples for this function

See also