Share via


ISpDataKey

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This interface provides a mechanism for storing and retrieving string and other data. The main use for this interface is in conjunction with object tokens, which implement the ISpObjectToken interface (which inherits from ISpDataKey). For example, data can be stored in an object token representing a recognizer or TTS engine by using this interface.

When to Implement

  • SpObjectToken is the standard class used for all existing SAPI object tokens. The data for each object token is stored in the registry.
  • SpDataKey is a class that stores the data associated with the data key in the registry.

Applications or engines can implement this interface directly to provide a custom data key implementation.

Methods

The following table lists the methods for the ISpDataKey interface.

Methods Description

CreateKey

Creates a new token subkey.

DeleteKey

Deletes a specified token key and all its descendants.

DeleteValue

Deletes a named value from the specified token.

EnumKeys

Enumerates the subkeys of the specified token.

EnumValues

Enumerates the values of the specified token.

GetData

Gets the binary data for a token.

GetDWORD

Gets the value information from a specified token.

GetStringValue

Gets the string value information from a specified token.

OpenKey

Opens a specified token subkey.

SetData

Sets the binary data for a token.

SetDWORD

Sets the value information for a specified token.

SetStringValue

Sets the string value information for a specified token.

Requirements

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

SAPI Interfaces