VMS Help  —  RTL Routines, STR$  STR$ELEMENT
    The Extract Delimited Element Substring routine extracts an
    element from a string in which the elements are separated by a
    specified delimiter.

    Format

      STR$ELEMENT  destination-string ,element-number

                   ,delimiter-string ,source-string

1  –  Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

2  –  Arguments

 destination-string

    OpenVMS usage:char_string
    type:         character string
    access:       write only
    mechanism:    by descriptor

    Destination string into which STR$ELEMENT copies the selected
    substring. The destination-string argument is the address of a
    descriptor pointing to the destination string.

 element-number

    OpenVMS usage:longword_signed
    type:         longword (signed)
    access:       read only
    mechanism:    by reference

    Element number of the delimited element substring to be returned.
    The element-number argument is the address of a signed longword
    containing the desired element number. Zero is used to represent
    the first delimited element substring, one is used to represent
    the second, and so forth.

 delimiter-string

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor

    Delimiter string used to separate element substrings. The
    delimiter-string argument is the address of a descriptor pointing
    to the delimiter string. The delimiter-string argument must be
    exactly one character long.

 source-string

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor

    Source string from which STR$ELEMENT extracts the requested
    delimited substring. The source-string argument is the address
    of a descriptor pointing to the source string.
Close Help