Partager via

ISpObjectTokenCategory::GetDefaultTokenId

  • Article

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.

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 Values

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

OS Versions: Windows CE .NET 4.1 and later.
Header: sapi.h, sapi.idl.
Link Library: Sapilib.lib.

See Also

ISpObjectTokenCategory | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.