ISpObjectToken::SetId (SAPI 5.4)

Speech API 5.4
Microsoft Speech API 5.4

ISpObjectToken::SetId

ISpObjectToken::SetId sets the CategoryId for object token.

This may be called only once.


HRESULT SetId(
   LPCWSTR       *pszCategoryId,
   LPCWSTR       *pszTokenId,
   BOOL           fCreateIfNotExist
);

Parameters

pszCategoryId
[in] The null-terminated string name of category to set.
pszTokenId
[in] The null-terminated string name of token to set.
fCreateIfNotExist
[in] A Boolean indicating the object is to be created if not currently existing. TRUE allows the creation; FALSE does not.

Return values

ValueDescription
S_OKFunction completed successfully.
SPERR_ALREADY_INITIALIZEDCategory interface is already initialized.
SPERR_TOKEN_DELETEDKey has been deleted.
E_INVALIDARGEither pszCategoryId and/or pszTokenId is invalid or bad.
FAILED(hr)Appropriate error message.

Notes

CategoryIds appear in the fully qualified form as:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Speech\Recognizers


The only acceptable HKEYs are:

HKEY_CLASSES_ROOT,

HKEY_CURRENT_USER,

HKEY_LOCAL_MACHINE,

HKEY_CURRENT_CONFIG

Show: