ISpDataKey::GetStringValue

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method gets the string value from a specified token.

Syntax

HRESULT GetStringValue(
  const WCHAR* pszValueName, 
  WCHAR** ppszValue
);

Parameters

  • pszValueName
    [in] Pointer to a null-terminated string specifying the registry key name. If this value is NULL, the method retrieves the default value of the token.
  • ppszValue
    [out] Address of a pointer to a null-terminated string specifying the value of the token.

Return Value

The following table shows the possible return values.

Value Description

S_OK

Function completed successfully.

E_INVALIDARG

pszValueName is invalid or bad.

E_POINTER

ppszValue is invalid or bad.

SPERR_NOT_FOUND

Registry file not found.

FAILED(hr)

Appropriate error message.

Requirements

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

ISpDataKey
SAPI Interfaces