RecognizerUpdateReachedEventArgs Class

Returns data from the RecognizerUpdateReached event.

Namespace: Microsoft.Speech.Recognition
Assembly: Microsoft.Speech (in microsoft.speech.dll)

Syntax

'Declaration
Public Class RecognizerUpdateReachedEventArgs
    Inherits EventArgs

public class RecognizerUpdateReachedEventArgs : EventArgs

public ref class RecognizerUpdateReachedEventArgs : public EventArgs

public class RecognizerUpdateReachedEventArgs extends EventArgs

public class RecognizerUpdateReachedEventArgs extends EventArgs

Remarks

An instance of RecognizerUpdateReachedEventArgs is created when the SpeechRecognitionEngine. RecognizerUpdateReached event is raised.

SpeechRecognitionRejectedEventArgs derives from System.EventArgs.

RecognizerUpdateReached events are generated to provide a mechanism for pausing a recognition engine to apply atomic and synchronous modifications.

An application uses the RequestRecognizerUpdate to request the generation RecognizerUpdateReached events.

Inheritance Hierarchy

System.Object
   System.EventArgs
    Microsoft.Speech.Recognition.RecognizerUpdateReachedEventArgs

Example

The example below show a handler for RecognizerUpdateReached events which loads or unloads Recognition Grammar objects. The handler uses UserToken to obtain information about the recognizer request, created with RequestRecognizerUpdate ,to verify and implement the request.

//Handle requests for Grammar Loads.
_recognizer.RecognizerUpdateReached +=
   delegate(object s, RecognizerUpdateReachedEventArgs args) {
       GrammarRequest request = args.UserToken as GrammarRequest; //cast and check if incoming type is a request
       if (request != null) { // We know this is a Grammar request now
           if (request.Grammar == null)
               throw new ArgumentException("Invalid grammar used.");
       }
       switch (request.RequestType) {
           case GrammarRequestType.LoadGrammarSync:
               RemoveDuplicateGrammar(request.Grammar);
               _recognizer.LoadGrammar(request.Grammar);
               DisplayGrammarLoad(request.Grammar);
               break;
           case GrammarRequestType.LoadGrammarAsync:
               RemoveDuplicateGrammar(request.Grammar);
               _recognizer.LoadGrammarAsync(request.Grammar);
               break;
           case GrammarRequestType.UnloadGrammar:
               _recognizer.UnloadGrammar(request.Grammar);
               DisplayGrammarUnload(request.Grammar);
               break;
       }

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

RecognizerUpdateReachedEventArgs Members
Microsoft.Speech.Recognition Namespace
RecognizerUpdateReached
RequestRecognizerUpdate