Edit

Share via

IItemPropertyBag::Write method

  • Article

Causes one or more properties to be saved into the property bag. The IItemPropertyBag interface is supported only on Windows XP and Windows Server 2003, and should no longer be used.

Syntax

HRESULT Write(
  [in] ULONG    cProperties,
  [in] ITEMPROP *pPropBag,
  [in] VARIANT  *pvarValue
);

Parameters

cProperties [in]

The number of properties to save. This argument specifies the number of elements in the arrays at pPropBag and pvarValue.

pPropBag [in]

Pointer to an array of ITEMPROP structures that specifies the properties to be saved.

pvarValue [in]

Pointer to a VARIANT whose type depends on the data type of the property information that it contains.

Return value

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

Remarks

The IItemPropertyBag interface is supported only on Windows XP and Windows Server 2003, and should no longer be used.

To preview attachments with a third-party protocol handler on computers running Windows XP or Windows Server 2003, it may be necessary to use the IItemPropertyBag interface and the following APIs: the ISearchProtocolUI, IItemPreviewerExt and ISearchItem interfaces, the LINKINFO and ITEMPROP structures, and the LINKTYPE enumeration.

Requirements

Requirement Value
Minimum supported client
 Windows XP with SP2 [desktop apps only]
Minimum supported server
 Windows Server 2003 [desktop apps only]
Redistributable
 Windows Desktop Search (WDS) 3.0

See also

IItemPropertyBag