ISpObjectToken::SetId
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 method sets the category identifier for an object token. The client can call this method only once.
Syntax
HRESULT SetId(
const WCHAR* pszCategoryId,
const WCHAR* pszTokenId,
BOOL fCreateIfNotExist
);
Parameters
- pszCategoryId
[in] Pointer to a null-terminated string specifying the category identifier.
- pszTokenId
[in] Pointer to a null-terminated string specifying the token identifier.
- fCreateIfNotExist
[in] Value indicating if the method is to create the object if it does not already exist. Set this value to TRUE to enable creation, and to FALSE otherwise.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
SPERR_ALREADY_INITIALIZED |
Category interface is already initialized. |
SPERR_TOKEN_DELETED |
Key has been deleted. |
E_INVALIDARG |
Either pszCategoryId and, or pszTokenId is invalid or bad. |
FAILED(hr) |
Appropriate error message. |
Remarks
Category identifiers appear in the fully qualified form as keys in the following path:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Speech\Recognizers
The following list shows the only acceptable registry keys:
- HKEY_CLASSES_ROOT
- HKEY_CURRENT_USER
- HKEY_LOCAL_MACHINE
- HKEY_CURRENT_CONFIG
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |