SpSetDescription
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 sets the resource description for the specified token.
Syntax
inline HRESULT SpSetDescription(
ISpObjectToken* pObjToken,
const WCHAR* pszDescription,
LANGID Language = SpGetUserDefaultUILanguage(),
BOOL fSetLangIndependentId = TRUE
);
Parameters
- pObjToken
[in] Pointer to an object implementing ISpObjectToken for the target resource.
- pszDescription
[in] Pointer to a null-terminated string specifying the resource description.
- Language
[in] Optional identifier for the language associated with the resource. If the identifier is omitted, the default language is used. The SpGetUserDefaultUILanguage function is used to retrieve the identifier.
- fSetLangIndependentId
[in] Value indicating if the method should also change the language-independent identifier. Set this value to TRUE to change the identifier, 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. |
E_INVALIDARG |
Either pszDescription or the language description is invalid or bad. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sphelper.h |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |