.. highlight:: us

.. index:: Seq_SwitchWorkspace

.. _seq_switchworkspace:

Seq_SwitchWorkspace
===================

.. us.tag Seq_SwitchWorkspace sequencer New6600

:ref:`Seq_SwitchWorkspace` switches the sequencer to an existing workspace.
If the sequencer is already executing a sequence at this point of time, e.g. because
the function is called from a Run Script Action, the call will be placed in a queue
together with calls of :ref:`Seq_RunSequence` and executed after the current sequence run 
has finished.

.. function:: bool = Seq_SwitchWorkspace(sFolderPath)

.. us.return

**Return Value**

If the function succeeds and sFolderPath points to a valid workspace folder,
the return value is TRUE (1); otherwise it is FALSE (0). Valid workspace folders 
contain at least the folder "Sequences".
If the call has to be placed in the queue, the return value is always TRUE (1).

.. us.params

**Parameters**

.. uparam:: sFolderPath

   *sFolderPath* is the path to the workspace folder.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2024.4
     - New.

.. seealso::
   :ref:`Seq_RunSequence`,
   :ref:`sequencer`

:sub:`id-1696442`