<help>

Catches the help event.

Syntax

<help
    cond = "CDATA"
    count = "integer"
/>

Attributes

Attribute

Data Type

Required?

Default

Description

cond

CDATA

no

NA

Boolean expression that must evaluate to ECMAScript true for the <help> element to execute.

count

integer

no

NA

Numerical occurrence of the help event, such as 2 for the second occurrence. This allows you to handle different occurrences of the help event in different ways.

Details

The <help> element is shorthand for <catch event="help">.

Parents

<field>, <form>, <initial>, <menu>, <object>, <record>, <subdialog>, <transfer>, <vxml>

Children

<assign>, <audio>, <clear>, <data>, <disconnect><enumerate>, <exit>, <foreach>, <goto>, <if>, <log>, <prompt>, <reprompt>, <return>, <script>, <submit>, <throw>, <value><var>

Example

<?xml version="1.0"?>
<vxml version="2.1" xmlns="http://www.w3.org/2001/vxml">
    <catch event="terminate">
        Caught terminate
        <goto next="#formExit"/>
    </catch>
    <help>
        <audio src="../../audio/help.wav" maxage="0"/>
            Help requested
        <goto next="#formEntry"/>
    </help>
    <error>
        Caught error
        <goto next="#formExit"/>
    </error>
    <var name="bCondition" expr="false"/>
    <form id="formEntry">
        <catch event="customEvent">
            Form scope custom handler
            Throwing terminate
            <throw event="terminate"/>
        </catch>
        <catch event="terminate" cond="bCondition">
            This handler will not be executed due to the condition
        </catch>
        <block>
            Throwing custom event
            <throw event="customEvent"/>
        </block>
   </form>
   <form id="formExit">
       <block>
           Goodbye
           <exit/>
       </block>
   </form>
</vxml>

See Also

<catch>