[ Strings and Atoms | The ECLiPSe Built-In Predicates | Reference Manual | Alphabetic Index ]

# concat_string(++List, -Dest)

Succeeds if Dest is the concatenation of the atomic terms contained in List.

List
  List of atomic terms.
Dest
  String or variable.

## Description

Dest is unified with the concatenation of the atomic terms contained in List. List may contain numbers, atoms and strings. The result of the concatenation is always a string.

### Modes and Determinism

- concat_string(++, -) is det

### Exceptions

(4) instantiation fault
  List is not instantiated (non-coroutine mode only).
(4) instantiation fault
  List contains free variables (non-coroutine mode only).
(5) type error
  List is instantiated, but not to a list of atomic terms.
(5) type error
  Dest is neither an string nor a variable.

## Examples

    Success:
          concat_string([abc,def],"abcdef").

          concat_string(["Str1","Str2"],X).
                                 X = "Str1Str2".

          concat_string([the,man," is aged ",20],X).
                                 X = "theman is aged 20".

          concat_string([1,2,3],X).
                                 X = "123".

    Fail:
          concat_string([ab,bc],"abc").

    Error:
          concat_string(A,X).        (Error 4).
          concat_string([abc,D],X).  (Error 4).
          concat_string(art,X).      (Error 5).

## See Also

concat_atom / 2, concat_strings / 3, append_strings / 3, atom_string / 2, join_string / 3, split_string / 4