Add Method (String[])

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Adds an array containing one or more String objects to the set of alternatives.

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

Syntax

Visual Basic (Declaration)
Public Sub Add ( _
	ParamArray phrases As String() _
)
Visual Basic (Usage)
Dim instance As Choices
Dim phrases As String()

instance.Add(phrases)
C#
public void Add(
	params string[] phrases
)

Parameters

phrases
Type: array<System..::..String>[]()[][]

The strings to add to this Choices object.

Remarks

Applications can use both Add(array<String>[]()[][]) and Add(array<GrammarBuilder>[]()[][]) to add alternatives to a Choices object.

If phrases is an empty array, this method does not update the set of alternates.

This method throws an ArgumentNullException when phrases is nullNothingnullptrunita null reference (Nothing in Visual Basic) or any of the array elements are nullNothingnullptrunita null reference (Nothing in Visual Basic). This method throws an ArgumentException if any element in the array is the empty string ("").

Examples

The following example creates a speech recognition grammar for phrases similar to "Call Anne on her cell" and "Call James on his work phone". The example uses both overloads of the Add method to build the grammar.

 Copy imageCopy Code
public Grammar CreatePhonePhrase()
{

  // Create alternatives for female names and add a phrase.
  GrammarBuilder females = new Choices(new string[] { "Anne", "Mary" });
  females.Append("on her");

  // Create alternatives for male names and add a phrase.
  GrammarBuilder males = new Choices(new string[] { "James", "Sam" });
  males.Append("on his");

  // Create a Choices object that contains an array of alternative
  // GrammarBuilder objects.
  Choices people = new Choices();
  people.Add(new Choices(new GrammarBuilder[] {females, males}));

  // Create a Choices object that contains a set of alternative phone types.
  Choices phoneType = new Choices();
  phoneType.Add(new string[] { "cell", "home", "work" });

  // Construct the phrase.
  GrammarBuilder gb = new GrammarBuilder();
  gb.Append("call");
  gb.Append(people);
  gb.Append(phoneType);
  gb.Append(new GrammarBuilder("phone"), 0, 1);

  return new Grammar(gb);
}

See Also