Append Method (GrammarBuilder, Int32, Int32)

Microsoft Speech Platform SDK 11

Collapse image Expand Image Copy image CopyHover image

Appends a repeated grammar element to the current sequence of grammar elements.

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

Syntax

Visual Basic (Declaration)
Public Sub Append ( _
	builder As GrammarBuilder, _
	minRepeat As Integer, _
	maxRepeat As Integer _
)
Visual Basic (Usage)
Dim instance As GrammarBuilder
Dim builder As GrammarBuilder
Dim minRepeat As Integer
Dim maxRepeat As Integer

instance.Append(builder, minRepeat, maxRepeat)
C#
public void Append(
	GrammarBuilder builder,
	int minRepeat,
	int maxRepeat
)

Parameters

builder
Type: Microsoft.Speech.Recognition..::..GrammarBuilder

The repeated grammar element to append.

minRepeat
Type: System..::..Int32

The minimum number of times that input matching the element defined by builder must occur to constitute a match.

maxRepeat
Type: System..::..Int32

The maximum number of times that input matching the element defined by builder can occur to constitute a match.

Remarks

The value of minRepeat must be greater than or equal to 0 and less than or equal to the value of maxRepeat.

Important noteImportant

When you specify repeats for a GrammarBuilder object that contains SemanticResultValue or SemanticResultKey instances, make sure you avoid creating duplicate semantic elements with the same key name or multiple semantic elements that could repeatedly modify the Value property of a SemanticValue object. The speech recognizer can throw an exception if it encounters these circumstances. For more information about building a speech recognition grammar that contains semantic information, see Add Semantics to a GrammarBuilder Grammar (Microsoft.Speech).

Examples

The following example creates a speech recognition grammar for phrases such as "Call James at work" and "Call Anne on her cell phone", where the word "phone" is optional. GrammarBuilder and Choices objects are used to construct the grammar. The example highlights the use of the Append method.

C# Copy imageCopy Code
public static Grammar CreatePhonePhrase()
{
  // Create alternatives for person names, locations, devices, and pronouns.
  Choices personChoice = new Choices(new string[] {"Anne", "James", "Mary", "Sam"});
  Choices locationChoice = new Choices(new string[] {"home", "work"});
  Choices deviceChoice = new Choices(new string[] {"home", "work", "cell"});
  Choices pronounChoice = new Choices(new string[] {"his", "her"});

  // Create a phrase for the receiving device, which optionally contains the word "phone".
  GrammarBuilder devicePhrase = new GrammarBuilder(pronounChoice);
  devicePhrase.Append(deviceChoice);
  devicePhrase.Append("phone", 0, 1);

  // Create alternatives for phrases specifying a device or a location.
  GrammarBuilder atLocation = new GrammarBuilder("at");
  atLocation.Append(locationChoice);

  GrammarBuilder onDevice = new GrammarBuilder("on");
  onDevice.Append(devicePhrase);

  Choices howChoice = new Choices(new GrammarBuilder[] {atLocation, onDevice});

  // Build the final phrase.
  GrammarBuilder callWho = new GrammarBuilder("Call");
  callWho.Append(personChoice);
  callWho.Append(howChoice);

  // Create the Grammar object.
  Grammar callGrammar = new Grammar(callWho);
  callGrammar.Name = "Call Grammar";

  return callGrammar;
}

See Also