SpGetSubTokenFromToken (Windows CE 5.0)

Send Feedback

This function creates a subtoken from a token.

inline HRESULT SpGetSubTokenFromToken(ISpObjectToken* pToken,const WCHAR* pszSubKeyName,ISpObjectToken** ppToken,BOOL fCreateIfNotExist = FALSE);

Parameters

  • pToken
    [in] Pointer to an object implementing ISpObjectToken. If not present, the token is created if fCreateIfNotExist is TRUE.
  • pszSubKeyName
    [out] Pointer to the name of the subtoken to use.
  • ppToken
    [out] Address of a pointer to another object implementing ISpObjectToken for the newly created subtoken.
  • fCreateIfNotExist
    [in] Optional value indicating if the token is to be created if it does not currently exist. Set this value to TRUE to create the token, and to FALSE otherwise. FALSE is the default.

Return Values

The following table shows the return possible values.

Value Description
S_OK Function completed successfully.
E_POINTER At least one of the pointers pToken, pszSubKeyName, or ppToken is invalid or bad.
FAILED(hr) Appropriate error message.

Requirements

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

See Also

SAPI Functions

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.