GetPropertyInfo method

Gets information for properties in a property bag without actually getting those properties.

Syntax


HRESULT retVal = object.GetPropertyInfo(iProperty, cProperties, pPropBag, pcProperties);

Parameters

iProperty [in]

Type: unsigned long

The zero-based index of the first property for which information is requested. This argument must be less than the number of properties retrieved by IPropertyBag2::CountProperties.

cProperties [in]

Type: unsigned long

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

pPropBag [out]

Type: PROPBAG2

The 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]

Type: unsigned long

The address of a unsigned long that receives the number of properties for which information was retrieved. This argument cannot be NULL.

Remarks

When you implement this method, use CoTaskMemAlloc to allocate memory for the pstrName member of pPropBag.

When you call this method, use CoTaskMemFree to free the pstrName member of pPropBag.

See also

Reference
PROPBAG2
PROPBAG2_TYPE

 

 

Show: