Edit

PSPropertyBag_WritePropertyKey function (propsys.h)

  • Article

Sets the property key value of a property in a property bag.

Syntax

PSSTDAPI PSPropertyBag_WritePropertyKey(
  [in] IPropertyBag   *propBag,
  [in] LPCWSTR        propName,
  [in] REFPROPERTYKEY value
);

Parameters

[in] propBag

Type: IPropertyBag*

A pointer to an IPropertyBag object that represents the property bag in which the property is stored.

[in] propName

Type: LPCWSTR

A null-terminated property name string.

[in] value

Type: REFPROPERTYKEY

A PROPERTYKEY structure that specifies the property key value to store in the property.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Property keys uniquely identify a property. For example, PKEY_Keywords corresponds to System.Keywords. This function succeeds only for properties registered as part of the property schema.

The property bag property function API converts between window types and the VARIANT type that is used to express values in a property bag. Doing so eases property bag usage, simplifies applications, and avoids common coding errors.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header propsys.h
Library Propsys.lib
DLL Propsys.dll (version 6.0 or later)

See also

PSPropertyBag_ReadPropertyKey