Helper SpSetDescription

Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

SpSetDescription

SpSetDescription sets the string value for the specified token.

Found in: sphelper.h

inline HRESULT SpSetDescription(
   ISpObjectToken  *pObjToken,
   const WCHAR     *pszDescription,
   LANGID           Language = SpGetUserDefaultUILanguage(),
   BOOL             fSetLangIndependentId = TRUE
);

Parameters

pObjToken
[in] The object token of the target resource.
pszDescription
[in] A null-terminated string containing the resource description.
Language
[in] The language ID for the resource. Language is optional and if omitted the default language will be used.
fSetLangIndependentId
[in] Boolean indicating whether the language independent ID is also changed. TRUE, changes it; FALSE does not. If fSetLangIndependentId omitted the default TRUE will be used.

Return values

Value Description
S_OK Function completed successfully.
E_INVALIDARG Either pszDescription or the language description is invalid or bad.
FAILED(hr) Appropriate error message.