.. highlightlang:: us

.. _strtok:

strtok
======

.. index:: strtok

.. us.tag  strtok ENGLISH STR Changed310

:ref:`strtok` finds all tokens in a scalar string.

.. function::  svToken = strtok(ssString, ssDelimiter)
    svToken = strtok(ssString, ssDelimiter, bIgnoreLeadingDelimiters)

.. us.return

**Return Value**

*svToken* is a string column vector with string tokens.

.. us.params

**Parameters**

.. uparam:: ssString

   *ssString* is a scalar string.

.. uparam:: ssDelimiter

   *ssDelimiter* is a scalar string with
   delimiter characters. The delimeters will be removed from *ssString*.

.. uparam:: bIgnoreLeadingDelimiters

   The number of fields returned equals the number of delimeters + 1 if
   *bIgnoreLeadingDelimiters* is FALSE (0).  If *bIgnoreLeadingDelimiters* is
   TRUE (1) the function skips leading delimiters for each token. The default value
   for *bIgnoreLeadingDelimiters* is TRUE (1).

.. us.example

**Example**

::

   strtok("1,2,3;4,5", ",;")'
   1
   2
   3
   4
   5

The following example returns 2 tokens:

::

   strtok("1;;2", ";")'
   1
   2

The following example returns 3 tokens:

::

   strtok("1;;2", ";", FALSE)'
   1

   2

.. seealso::
   :ref:`overview-strings`,
   :ref:`sum`,
   :ref:`StringToField`

:sub:`id-243840`