
SpCreateNewToken (by CategoryId)
SpCreateNewToken creates a token coercively. The token is created with the specified name, if provided. Otherwise it will automatically generate both a key name and name.
Found in: sphelper.h
SpCreateNewToken(
const WCHAR *pszCategoryId,
const WCHAR *pszTokenKeyName,
ISpObjectToken **ppToken
);
Parameters
- pszCategoryId
- [in] The null-terminated string indicating the category ID.
- pszTokenKeyName
- [in out] The token name being created. If NULL, a unique token key name will be generated. If a name is provided it will append Tokens before it.
- ppToken
- [out] The newly created token. The token will be created, if one does not currently exist.
Return values
Value | Description |
---|---|
S_OK | Function completed successfully. |
FAILED (hr) | Appropriate error message. |
Example
The following code snippet illustrates the use of SpCreateNewToken (by Category Id) with the SPCAT_RECOPROFILE category.
HRESULT hr = S_OK;
// create a new recognition profile
hr = SpCreateNewToken(SPCAT_RECOPROFILES, NULL, &cpObjectToken);
// Check hr