IPortableDeviceValues::GetStringValue method

The GetStringValue method retrieves a string value (type VT_LPWSTR) specified by a key.

Syntax

HRESULT GetStringValue(
  [in]  REFPROPERTYKEY key,
  [out] LPWSTR         *pValue
);

Parameters

key [in]

A REFPROPERTYKEY key that specifies the item to retrieve.

pValue [out]

Pointer to the retrieved LPWSTR value. The caller is responsible for calling CoTaskMemFree to release the memory.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.
DISP_E_TYPEMISMATCH
The property specified by key is not an LPWSTR type.
HRESULT_FROM_WIN32(ERROR_NOT_FOUND)
The property specified by key is not in the collection.

Examples

For an example of how to use this method, see Retrieving Supported Service Events.

Requirements

Requirement Value
Header
PortableDeviceTypes.h
Library
PortableDeviceGUIDs.lib

See also

IPortableDeviceValues Interface

IPortableDeviceValues::GetAt

IPortableDeviceValues::SetStringValue

Retrieving Supported Service Events

Retrieving Supported Service Formats

Retrieving Supported Service Methods