PSPropertyBag_ReadStr function (propsys.h)

Reads the string data value of a property in a property bag.

Syntax

PSSTDAPI PSPropertyBag_ReadStr(
  [in]  IPropertyBag *propBag,
  [in]  LPCWSTR      propName,
  [out] LPWSTR       value,
  [out] int          characterCount
);

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.

[out] value

Type: LPCWSTR

When this function returns, contains a pointer to a string property value.

[out] characterCount

Type: int

This function returns the integer that represents the size (maximum number of characters) of the value parameter being returned.

Return value

Type: HRESULT

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

Remarks

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

See also

PSPropertyBag_WriteStr