IPropertyBag2::GetPropertyInfo Method

---

Retrieves information for properties in a property bag without actually retrieving the properties themselves.

Syntax

HRESULT GetPropertyInfo(
    ULONG iProperty,
    ULONG cProperties,
    PROPBAG2 *pPropBag,
    ULONG *pcProperties
);

Parameters

iProperty

[in] Zero-based index of the first property that information is being requested for. This argument must be less than the number of properties retrieved by IPropertyBag2::CountProperties.

cProperties

[in] Number of properties to retrieve information for. This argument specifies the number of array elements in pPropBag.

pPropBag

[out] Address of an array of PROPBAG2 structures that receive the information for the properties. There must be at least cProperties elements in this array. This argument cannot be NULL.

pcProperties

[out] Address of a ULONG that receives the number of properties that information was retrieved for. This argument cannot be NULL.

Return Value

Returns one of the following values:

S_OK	Information was successfully retrieved for all of the requested properties.
E_INVALIDARG	iProperty is greater than the number of properties in the property bag.
E_OUTOFMEMORY	A memory allocation error occurred.

See Also

PROPBAG2, PROPBAG2_TYPE