IPropertyStore::SetValue method (propsys.h)
This method sets a property value or replaces or removes an existing value.
Syntax
HRESULT SetValue(
REFPROPERTYKEY key,
REFPROPVARIANT propvar
);
Parameters
key
TBD
propvar
TBD
Return value
The IPropertyStore::SetValue method can return any one of the following:
| Return code | Description |
|---|---|
|
The property change was successful. |
|
The value was set but truncated. |
|
This is an error code. The property store was read-only so the method was not able to set the value. |
Remarks
IPropertyStore::SetValue affects the current property store instance only. A property handler implements IPropertyStore::SetValue by accumulating property changes in an in-memory data structure. Property changes are written to the stream only when IPropertyStore::Commit is called.
If IPropertyStore::Commit is called on a read-only property store, the property handler determines this and returns STG_E_ACCESSDENIED.
If a value was added or removed as a result of SetValue, subsequent enumerations by IPropertyStore::GetCount and IPropertyStore::GetAt reflect that change and subsequent calls to IPropertyStore::SetValue reflect the changed value.
Adding a New Property
If the property value that was pointed to by key does not exist in the store, IPropertyStore::SetValue adds the value to the store.
Replacing an Existing Property Value
If the property value that was pointed to by key already exists in the store, the stored value is replaced.
Removing an Existing Property
To remove a value from the property store, set the vt member of the structure that is pointed to by pv to VT_EMPTY. If that value is not present, do nothing and the method returns S_OK.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Available with Windows Vista and later versions of the Windows operating system. |
| Target Platform | Universal |
| Header | propsys.h |
| Library | Propsys.idl |
| IRQL | All levels |