IItemPropertyBag::GetPropertyInfo method

Gets the information required to read or save the properties in the property bag. The IItemPropertyBag interface is supported only on Windows XP and Windows Server 2003, and should no longer be used.

Syntax

HRESULT GetPropertyInfo(
  [in]  ULONG    iProperty,
  [in]  ULONG    cProperties,
  [out] ITEMPROP *pPropBag,
  [out] ULONG    *pcProperties
);

Parameters

iProperty [in]

The zero-based index of the first property for which information is requested.

cProperties [in]

The number of properties to get information for. This argument specifies the number of array elements in pPropBag.

pPropBag [out]

Pointer to an array of ITEMPROP structures that receives the information for the properties.

pcProperties [out]

Receives a pointer to a ULONG variable that receives the number of properties for which information was retrieved.

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