IConsole2::SetHeader method

Note  The IConsole2::SetHeader method is obsolete in MMC version 1.2 and later. It is no longer required by snap-ins. However, the method can still safely be used by snap-ins that already call it.

 

The IConsole2::SetHeader method sets the header interface to be used for this instance of IComponent. Be aware that this is used only by instances of IComponent.

Syntax

HRESULT SetHeader(
  [in] LPHEADERCTRL pHeader
);

Parameters

Return value

This method can return one of these values.

  • S_OK
    The header was successfully set.

  • E_UNEXPECTED
    An unexpected error occurred.

Remarks

The IConsole2::SetHeader method is obsolete in MMC version 1.2 and later. It is no longer required by snap-ins. However, the method can still safely be used by snap-ins that already call it.

The snap-in must instruct the console to release the IHeaderCtrl2 interface by calling IConsole2::SetHeader(NULL).

The best time to release the IHeaderCtrl2 interface is during a call to IComponent::Destroy.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Mmc.h

DLL

Mmcndmgr.dll

See also

IConsole3

IConsole2

IHeaderCtrl2