IPropertyContainer::GetPropertyContainer

virtual boolIPropertyContainer::GetPropertyContainer(const PropertyIdpropId, IPropertyContainer**container)

Retrieve a pointer to a nested property container.

Defined in: PropIface.h

Return Value

Returns true if the property ID passed in is a nested property, otherwise false.

Parameters

propId

Property ID to retrieve as a nested property.

container

Output parameter to receive pointer to the nested property container.

Comments

Some properties are compound or nested properties that contain properties of their own. For example, a font can be described as a compound property consisting of face name, font height, weight, bold, italic, etc. This function allows the caller to retrieve a property value as an IPropertyContainer. In other words, the value of a font is a pointer to another property container that can then be used to retrieve the individual font properties. This function fails if the property ID passed in does not correspond to a nested property.