ISpObjectTokenCategory::GetDefaultTokenId
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 gets the default token identifier for the category. There is a hierarchy for returning a default token identifier value. A default token has an attribute marked as DefaultTokenID. If no token is explicitly marked as such, the default token for the user profile is attempted. If there is no default token, SAPI returns a specially named token called DefaultdefaultTokenID for the category identifier.
Syntax
HRESULT GetDefaultTokenId(
const WCHAR** ppszCoMemTokenId
);
Parameters
- ppszCoMemTokenId
[out] Address of a pointer to a null-terminated string specifying the token identifier used as the default. The caller must release the object using CoTaskMemFree when it is no longer needed.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
SPERR_UNINITIALIZED |
Data key interface is not initialized. |
E_POINTER |
ppszCoMemTokenId is invalid or bad. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |