IItemPropertyBag::Read method

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

Syntax

HRESULT Read(
  [in]  ULONG    cProperties,
  [in]  ITEMPROP *pPropBag,
  [out] VARIANT  *pvarValue,
  [out] HRESULT  *phrError
);

Parameters

cProperties [in]

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

pPropBag [in]

Pointer to an array of ITEMPROP structures that specifies the properties that are requested.

pvarValue [out]

Receives a pointer that returns an array of VARIANT structures that receives the property values.

phrError [out]

Pointer to an array of HRESULT values that receives the result of each property read. There must be at least cProperties elements in this array.

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

See also

IItemPropertyBag