SHPropStgWriteMultiple function

[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


HRESULT SHPropStgWriteMultiple(
  _In_         IPropertyStorage *pps,
  _Inout_opt_  UINT *uCodePage,
  ULONG cpspec,
  _In_         PROPSPEC const rgpspec[],
  _Inout_      PROPVARIANT rgvar[],
  PROPID propidNameFirst
);

Parameters

pps [in]

Type: IPropertyStorage*

An IPropertyStorage interface pointer that identifies the property store.

uCodePage [in, out, optional]

Type: UINT*

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

cpspec

Type: ULONG

A count of properties being set.

rgpspec [in]

Type: PROPSPEC const[]

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

rgvar [in, out]

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

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Shlobj.h

Library

Shell32.lib

DLL

Shell32.dll (version 6.0 or later)

 

 

Community Additions

ADD
Show:
© 2014 Microsoft