doc/commands/Break.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3   "../docbook-xml/docbookx.dtd"
   4 [
   5 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   6 %myents;
   7 ]>
   8
   9 <!-- $Id: Break.xml,v 1.3 2007/06/16 12:38:45 griph Exp $ -->
  10
  11 <section id='Break'>
  12 <title>Break</title>
  13
  14 <cmdsynopsis>
  15         <command>Break</command>
  16         <arg choice='opt'
  17                 ><replaceable>levels</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>If the break command is used in a function, function execution is
  22 terminated immediately.  Further commands of the function are not
  23 processed.  Normally, all nested invocations of complex functions
  24 are left.  An optional integer number
  25 <replaceable>levels</replaceable>
  26 may be given to break out of the given number of nested functions
  27 and continue execution of a higher level function.
  28 The
  29 <emphasis remap='B'>Break</emphasis>
  30 command always has the return code -2.  Example:</para>
  31
  32 <programlisting>
  33 <fvwmref cmd="AddToFunc"/> PickWindowRaiseAndDeiconify
  34 + I <fvwmref cmd="Pick"/>
  35 + I <fvwmref cmd="TestRc"/> (Error) Break
  36 + I <fvwmref cmd="Raise"/>
  37 + I <fvwmref cmd="Iconify"/> off
  38 </programlisting>
  39
  40
  41 </section>