IColumnData interface

The IColumnData interface is introduced in MMC 1.2.

The IColumnData interface enables a snap-in to set and retrieve the persisted view data of list view columns to use for column customization. For more information about when to use the IColumnData interface, see Using IColumnData.

The interface provides methods for programmatically providing the same functionality that MMC provides in the Modify Columns dialog box. In addition, the IColumnData interface provides methods for setting and retrieving the sorted column and sort direction of a particular column set.

All data set and retrieved by the methods of the IColumnData interface is persisted by MMC in memory, and not in a stream or storage medium. This data is persisted to an .msc console file only when the user chooses the Save menu command.

MMC persists column data (also called column configuration data) per column set (using a column set ID) per view per snap-in instance. Within each view, each column set ID references its own column configuration data. The snap-in can use the IColumnData interface pertaining to the particular view to access the column configuration data of that view.

For more information about column customization, see Using Column Persistence.

The IColumnData interface can be queried from the IConsole passed into IComponent::Initialize during the component creation.

When to implement

Do not implement this interface. It is implemented by MMC.

When to use

Use IColumnData when your snap-in requires access the persisted view data of its list view columns. Be aware that the interface can affect the display of list views.

Members

The IColumnData interface inherits from the IUnknown interface. IColumnData also has these types of members:

Methods

The IColumnData interface has these methods.

MethodDescription
GetColumnConfigData

Retrieves the width, order, and hidden status of columns in a column set.

GetColumnSortData

Retrieves the sorting direction for columns in a column set.

SetColumnConfigData

Sets the width, order, and hidden status of columns in a column set.

SetColumnSortData

Sets the sorting direction for columns in a column set.

 

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Mmc.h

DLL

Mmcndmgr.dll

See also

Using Column Persistence
Using IColumnData

 

 

Show: