Edit

Share via

SHPropStgWriteMultiple function (shlobj_core.h)

  • Article

[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::WriteMultiple function to ensure that ANSI and Unicode translations are handled properly for deprecated property sets.

Syntax

SHSTDAPI SHPropStgWriteMultiple(
  [in]                IPropertyStorage  *pps,
  [in, out, optional] UINT              *puCodePage,
                      ULONG             cpspec,
  [in]                PROPSPEC const [] rgpspec,
  [in, out]           PROPVARIANT []    rgvar,
                      PROPID            propidNameFirst
);

Parameters

[in] pps

Type: IPropertyStorage*

An IPropertyStorage interface pointer that identifies the property store.

[in, out, optional] puCodePage

Type: UINT*

A pointer to the code page value for ANSI string properties.

cpspec

Type: ULONG

A count of properties being set.

[in] rgpspec

Type: PROPSPEC const[]

An array of PROPSPEC structures that contain the property information to be set.

[in, out] rgvar

Type: PROPVARIANT[]

An array of PROPVARIANT types to set the property values.

propidNameFirst

Type: PROPID

The minimum value for property identifiers when they must be allocated. The value should be greater than or equal to PID_FIRST_USABLE.

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)