Share via


Note

Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.

SrgsRule.Id Property

Gets or sets the identifier for the rule.

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

Syntax

'Declaration
Public Property Id As String
    Get
    Set
'Usage
Dim instance As SrgsRule
Dim value As String

value = instance.Id

instance.Id = value
public string Id { get; set; }

Property Value

Type: System.String
The identifier for the rule.

Exceptions

Exception Condition
FormatException

An attempt is made to set Id to an invalid value.

Remarks

The identifier for a rule is a string that contains the name of the rule.

A value used to set Id must adhere to the following rules:

  • The value must be a valid XML name, as defined in Extensible Markup Language (XML) 1.0 (Fifth Edition). To paraphrase this definition, a valid XML name must begin with a letter, an underscore ('_'), or a colon (':') and can be followed by zero or more NameChar characters (also defined in the XML specification).

  • The value can be "NULL" or "VOID" or "GARBAGE".

  • The value cannot contain any invalid rule ID character. These characters are: '?', '*', '+', '|', '(', '), '^', '$', '/', ';', '.', '=', '<', '>', '[', ']', '{', '}', '\\', ' ', '\t', '\r', and '\n'.

See Also

Reference

SrgsRule Class

SrgsRule Members

Microsoft.Speech.Recognition.SrgsGrammar Namespace

Other Resources

Create Grammars Using SrgsGrammar (Microsoft.Speech)