SHPropStgReadMultiple function (shlobj_core.h)

[This function is available through Windows XP Service Pack 2 (SP2) and Windows Server 2003. It might be altered or unavailable in subsequent versions of Windows.]

Wraps the IPropertyStorage::ReadMultiple function to ensure that ANSI and Unicode translations are handled properly for deprecated property sets.

Syntax

SHSTDAPI SHPropStgReadMultiple(
  [in]  IPropertyStorage  *pps,
        UINT              uCodePage,
        ULONG             cpspec,
  [in]  PROPSPEC const [] rgpspec,
  [out] PROPVARIANT []    rgvar
);

Parameters

[in] pps

Type: IPropertyStorage*

An IPropertyStorage interface pointer that identifies the property store.

uCodePage

Type: UINT

A code page value for ANSI string properties.

cpspec

Type: ULONG

A count of properties being read.

[in] rgpspec

Type: PROPSPEC const[]

An array of properties to be read.

[out] rgvar

Type: PROPVARIANT[]

An array of PROPVARIANT types that, when this function returns successfully, receives the property values.

Return value

Type: HRESULT

If this function 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
Library Shell32.lib
DLL Shell32.dll (version 6.0 or later)