Edit

IPropertyStoreCapabilities::IsPropertyWritable method (propsys.h)

  • Article

Queries whether the property handler allows a specific property to be edited in the UI by the user.

Syntax

HRESULT IsPropertyWritable(
  [in] REFPROPERTYKEY key
);

Parameters

[in] key

Type: REFPROPERTYKEY

A reference to PROPERTYKEY structure that represents the property being queried.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 The property can be edited and stored by the handler.
S_FALSE
 The property cannot be edited.

Remarks

The Shell disables the editing of controls by the user as appropriate through this method. A handler that does not support IPropertyStoreCapabilities is assumed to support writing of any property.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header propsys.h