ISpObjectTokenCategory::GetDefaultTokenId (SAPI 5.3)

  • Article

Microsoft Speech API 5.3

ISpObjectTokenCategory::GetDefaultTokenId

ISpObjectTokenCategory::GetDefaultTokenId retrieves the default token ID for the category.

  
    HRESULT GetDefaultTokenId(
   LPWSTR   **ppszCoMemTokenId
);

Parameters

  • ppszCoMemTokenId
    [in] The null-terminated string name of the token ID used as the default. Must be released with CoMemTaskFree () when no longer needed.

Return values

Value
S_OK
SPERR_UNINITIALIZED
E_POINTER
FAILED(hr)

Remarks

There is a hierarchy for returning a default token ID value. A default token has an attribute marked as DefaultTokenID. When a token is not explicitly marked as such, SAPI attempts to return the default from the user profile. If none exists there, SAPI returns a specially named token called DefaultdefaultTokenID for the category ID. Default tokens are discussed in Object Tokens and Registry Settings White Paper.