Edit

Share via

INamedPropertyBag::ReadPropertyNPB method (shlobj_core.h)

  • Article

Causes a property to be read from the named property bag.

Syntax

HRESULT ReadPropertyNPB(
  [in]      PCWSTR      pszBagname,
  [in]      PCWSTR      pszPropName,
  [in, out] PROPVARIANT *pVar
);

Parameters

[in] pszBagname

Type: PCWSTR

A pointer to a string that contains the name of the property bag.

[in] pszPropName

Type: PCWSTR

A pointer to a string that contains the name of the property to be read.

[in, out] pVar

Type: PROPVARIANT*

The address of a VARIANT that, when this method returns successfully, receives the property value.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shlobj_core.h
DLL Shdocvw.dll