SpGetDescription
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 text description associated with the specified object token.
Syntax
inline HRESULT SpGetDescription(
ISpObjectToken* pObjToken,
WCHAR** ppszDescription,
LANGID* Language = SpGetUserDefaultUILanguage()
);
Parameters
- pObjToken
[in] Pointer to an object implementing ISpObjectToken for the object token corresponding to the target resource.
- ppszDescription
[out] Address of a pointer to a null-terminated string describing the target resource.
- Language
[in] Optional pointer to the language identifier for the resource. If the value is omitted, the default language will be used.
Return Value
This helper function calls ISpDataKey::GetStringValue. See the return values for that method.
Requirements
| Header | sphelper.h |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |