INodeProperties::GetProperty method (mmc.h)

Article
02/22/2024

The GetProperty method retrieves text-only property values for a node. Your implementation of the INodeProperties::GetProperty method is called when an application based on the MMC 2.0 Automation Object Model retrieves the Node.Property property.

Syntax

HRESULT GetProperty(
  [in]  LPDATAOBJECT pDataObject,
  [in]  BSTR         szPropertyName,
  [out] PBSTR        pbstrProperty
);

Parameters

[in] pDataObject

A pointer to the snap-in data object.

[in] szPropertyName

The name of the property retrieved.

[out] pbstrProperty

Text value for the property.

Return value

The snap-in returns S_OK if it provides the property value when this method is called. If the snap-in returns S_FALSE, then the data object is queried for the property value.

Remarks

The Extended View extension uses two properties: CCF_DESCRIPTION and CCF_HTML_DETAILS. As an alternative to supplying values for these properties using the data object to query the CCF_DESCRIPTION and CCF_HTML_DETAILS clipboard formats, a snap-in can use INodeProperties::GetProperty to return the property values to the Extended View. This alternative is beneficial in situations where a snap-in's data object does not provide the desired information.

In addition to providing CCF_DESCRIPTION and CCF_HTML_DETAILS property values, a snap-in can use INodeProperties to provide values for other text-based properties (for example, with a new view extension).

For more information and a code example for INodeProperties::GetProperty, see Using the Extended View Extension - Implementation Details.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	mmc.h