Deactivate() method

Elements/Objects that the method can be called on

• <listen ...>
  • Attribute description:
    • The Deactivate method deactivates the grammars of a listen.
    • The first argument identifies the grammar for deactivation.
    • The optional second argument identifies a top-level rulename within that grammar.
    • If the grammar or rule is already deactivated, the call has no effect.
      
  • Syntax: Object.Deactivate(grammarName, [ruleName]);
    
  • Parameters:
    • grammarName: Required. Name of the grammar (i.e. the name attribute of the relevant grammar).
    • ruleName: Optional. Rule name within the grammar.
      
  • Retrun Value: none
    
  • Exception: There are no explicit exceptions associated with this method.
    • However, if the grammar identified with the grammarName argument does not exist, an onError event is fired and a value of -6 set in the status property of the listen object.
    • Note also that onError would be fired as a result of the listen.Start() method if the rule identified by the ruleName argument does not exist.

Example

Extra info

For details on usage of this element, see the SALT Specification, Version 1.0.