# $str.split

Splits a string to an array

Usage

    $str.split(<separator>,<data>[,<flags>[,<maxfields>]])

Description

Splits the <data> string by <separator> and returns an array of substrings.
<flags> may be a combination of the characters 's', 'w', 'r' and 'n'.
If s is specified, <separator> matching is case sensitive, otherwise is case insensitive.
If w is specified, <separator> is treated as a wildcard-type regular expression (with * and ? wildcars).
If r is specified, <separator> is treated as a extended-type regular expression (with character classes, special escapes etc..).
If both w and r are specified w takes precedence.
If none of w and r are specified <separator> is treated as a simple string to be matched.
If 'n' is specified then eventual empty fields are discarded.
If <maxfield> is specified then at most <maxfields> items are returned in the array (i.e. the last item may be not splitted completly).

Syntax Specification

    <array> $str.split(<separator:string>,<data:string>[,<flags:string>[,<maxfields:integer>]])

Examples

        # Split the fields
        %test[] = $str.split(!,"Field0!Field1!Field2!Field3!!Field5")
        echo %test[]
        %i = 0
        while(%i < %test[]#)
        {
            echo "Field %i: %test[%i]"
            %i++;
        }

Regexp splitting:

        %Test[] = $str.split("[ ]*[0-9][0-9]*-","AllOfThem: 1-Balboy 2-Pragma 3-Iakkolo 4-Crocodile",r)
        echo %Test[]
        %Test[] = $str.split("Y*H","hihiYeaHhohohoyeahYepYEAHhi",sw)
        echo %Test[]

If used in "non-array" context it returns just a comma separated list of substrings:

        echo $str.split("[ ]*","Condense spaces and change     all       it in commas",r)

Index, Functions

KVIrc 4.0.2.4740 Documentation
Generated by root at Tue Feb 1 06:16:04 2011