SpGetDefaultTokenFromCategoryId
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 function gets the default token for the specified category.
Syntax
inline HRESULT SpGetDefaultTokenFromCategoryId(
const WCHAR* pszCategoryId,
ISpObjectToken** ppToken,
BOOL fCreateCategoryIfNotExist = TRUE
);
Parameters
- pszCategoryId
[in] Pointer to the category identifier.
- ppToken
[out] Address of a pointer to an object implementing ISpObjectToken.
- fCreateCategoryIfNotExist
[in] An optional value indicating if the object is to be created if it does not already exist. Set this value to TRUE to create the object, and to FALSE otherwise. TRUE is the default.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sphelper.h |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |