Microsoft Speech SDK SAPI 5.1

---

ISpObjectToken::Remove

ISpObjectToken::Remove removes an object token.

HRESULT Remove(
   const CLSID  *pclsidCaller
);

Parameters

pclsidCaller

[in] Address of the identifier associated with the object token to remove. If pclsidCaller is NULL, the entire token is removed; otherwise, only the specified section is removed.

Return values

Value	Description
S_OK	Function completed successfully.
E_POINTER	pclsidCaller is invalid or bad.
SPERR_UNINITIALIZED	The token ID interface is uninitialized.
SPERR_TOKEN_DELETED	Key has been deleted.
FAILED(hr)	Appropriate error message.

Example

The following code snippet creates and removes a token object for a test file.

HRESULT hr;
GUID guid0;

CComPtr<ISpObjectToken> cpSpObjectToken;
CSpCoTaskMemPtr<WCHAR> cpFileName;

hr = SpGetDefaultTokenFromCategoryId(SPCAT_VOICES, &cpSpObjectToken);
//Check return value

ZeroStruct(guid0);
hr = cpSpObjectToken->GetStorageFileName( guid0, L"TestFile", NULL, CSIDL_FLAG_CREATE|CSIDL_APPDATA, &cpFileName);
//Check return value

hr = cpSpObjectToken->Remove(&guid0);
//Check return value