Caché SQL Reference
$LISTFROMSTRING
[Back] [Next]
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

A list function that creates a list from a string.
Synopsis
$LISTFROMSTRING(string,delimiter)
Arguments
string A string to be converted into a Caché list. This string contains one or more elements, separated by a delimiter. The delimiter does not become part of the resulting Caché list.
delimiter Optional — The delimiter used to separate substrings (elements) in string. Specify delimiter as a quoted string. If no delimiter is specified, the default is the comma (,) character.
Description
$LISTFROMSTRING takes a quoted string containing delimited elements and returns a list. A list represents data in an encoded format which does not use delimiter characters. Thus a list can contain all possible characters, and is ideally suited for bitstring data. Lists are handled using the Caché ObjectScript and Caché SQL $LIST functions.
Arguments
string
A string literal (enclosed in single quotation marks), a numeric, or a variable or expression that evaluates to a string. This string can contain one or more substrings (elements), separated by a delimiter. The string data elements must not contain the delimiter character (or string), because the delimiter character is not included in the output list.
delimiter
A character (or string of characters) used to delimit substrings within the input string. It can be a numeric or string literal (enclosed in single quotation marks), the name of a variable, or an expression that evaluates to a string.
Commonly, a delimiter is a designated character which is never used within string data, but is set aside solely for use as a delimiter separating substrings. A delimiter can also be a multi-character string, the individual characters of which can be used within string data. If you specify no delimiter, the default delimiter is the comma (,) character.
Examples
The following Embedded SQL example takes a string of names which are separated by a blank space, and creates a list:
   SET names="Deborah Noah Martha Bowie"
   &sql(SELECT $LISTFROMSTRING(:names,' ')
        INTO :namelist)
   IF SQLCODE=0 {
      FOR n=1:1:$LISTLENGTH(namelist) {WRITE !,"element ",n,": ",$LIST(namelist,n)}
   }
   ELSE {WRITE !,"Error code;",SQLCODE }
 
The following Embedded SQL example uses the default delimiter (the comma character), and creates a list:
   SET names="Deborah,Noah,Martha,Bowie"
   &sql(SELECT $LISTFROMSTRING(:names)
        INTO :namelist)
   IF SQLCODE=0 {
    FOR n=1:1:$LISTLENGTH(namelist) {WRITE !,"element ",n,": ",$LIST(namelist,n)}
   }
   ELSE {WRITE !,"Error code;",SQLCODE }
 
See Also