SpGetDescription (Windows CE 5.0)

  • Article

Send Feedback

This function gets the text description associated with the specified object token.

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 Values

This helper function calls ISpDataKey::GetStringValue. See the return values for that method.

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.