ISpObjectTokenCategory
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This interface defines an object token category. Each category represents a collection of similar tokens, such as voices, recognizers, and audio input devices. Categories can be created or manipulated with helper functions or methods from this interface. ISpObjectTokenCategory inherits from ISpDataKey.
Each category has a category identifier that is unique and identifies only one type of object token. Available categories are listed in Token Category IDs. Category identifiers are always null-terminated strings.
An application can create an object implementing ISpObjectTokenCategory and then call ISpObjectTokenCategory::SetId to set the category identifier for the object. The application can then enumerate the object tokens associated with the category by using ISpObjectTokenCategory::EnumTokens. The application can change and find the default object token for a category using calls to the methods ISpObjectTokenCategory::SetDefaultTokenId and ISpObjectTokenCategory::GetDefaultTokenId.
When to Implement
SpObjectTokenCategory is the standard class used for categories in SAPI. The category and the list of associated tokens are stored in the registry.
Applications typically create object token categories by directly creating the SpObjectTokenCategory class. If an application is using the category to find an associated token that matches certain attributes, it is often easier to use the helper functions SpEnumTokens or SpFindBestToken.
Methods
The following table shows the methods for the ISpObjectToken interface.
| Methods | Description |
|---|---|
Enumerates the tokens for the category. |
|
Gets the data key associated with a specific location. |
|
Gets the default token identifier for the category. |
|
Gets the token identifier. |
|
Sets a specific token identifier as the default for the category. |
|
Sets the category identifier. |
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |