IPortableDeviceValues::SetValue

  • Article

banner art

Previous Next

IPortableDeviceValues::SetValue

The SetValue method adds a new PROPVARIANT value or overwrites an existing one.

Syntax

  HRESULT SetValue(
  REFPROPERTYKEY  key,
  const PROPVARIANT*  pValue
);

Parameters

key

[in]  A REFPROPERTYKEY that specifies the item to create or overwrite.

pValue

[in]  A PROPVARIANT that specifies the new value. The SDK copies the value, so the caller can release the local variable by calling PropVariantClear after calling this method.

Return Values

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.

Remarks

This method can be used to retrieve a value of any type from the collection. However, if you know the value type in advance, use one of the specialized Set... methods of this interface to avoid the overhead of working with PROPVARIANT values directly.

If an existing value has the same key that is specified by the key parameter, it overwrites the existing value without any warning. The existing key memory is released appropriately.

Requirements

Header: Defined in PortableDeviceTypes.h

Library: PortableDeviceGUIDs.lib

See Also

Previous Next