PSPropertyBag_ReadLONG function (propsys.h)

Reads a LONG data value from a property in a property bag.

Syntax

PSSTDAPI PSPropertyBag_ReadLONG(
  [in]  IPropertyBag *propBag,
  [in]  LPCWSTR      propName,
  [out] LONG         *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.

[out] value

Type: LONG*

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

Return value

Type: HRESULT

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

Remarks

If the property bag does not already contain the specified property, the call still succeeds.

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_WriteLONG