Export (0) Print
Expand All
Expand Minimize

SHSetTemporaryPropertyForItem function

Sets a temporary property for the specified item. A temporary property is kept in a read/write store that holds properties only for the lifetime of the IShellItem object, instead of writing them back into the item.

Syntax


HRESULT SHSetTemporaryPropertyForItem(
  _In_  IShellItem *psi,
  _In_  REFPROPERTYKEY propkey,
  _In_  REFPROPVARIANT propvar
);

Parameters

psi [in]

Type: IShellItem*

A pointer to the item on which the temporary property is to be set.

propkey [in]

Type: REFPROPERTYKEY

Reference to the PROPERTYKEY that identifies the temporary property that is being set.

propvar [in]

Type: REFPROPVARIANT

Reference to a PROPVARIANT that contains the value of the temporary property.

Return value

Type: HRESULT

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

Remarks

A temporary value can only be read with SHGetTemporaryPropertyForItem or by passing GPS_TEMPORARY to IShellItem2::GetPropertyStore.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Shobjidl.h

Library

Shell32.lib

DLL

Shell32.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft