IMessageFormEx2::GetMenuCapability

4/8/2010

The GetMenuCapability method queries a Messaging add-in that implements the IMessageFormEx2 interface, to determine if it supports a particular command bar menu. This method provides an alternate mechanism to the one used by IMessageFormEx::GetMenuCapabilities—and uses an approach that supports hundreds of menu items.

Syntax

HRESULT GetMenuCapability (
  DWORD dwCapability,
  BOOL * pfEnabled
);

Parameters

• dwCapability
  [in] A single command bar capability constant. This includes constants from both the Standard and Extended set. For information, see Message Form Host Command Bar Capability Flags.

• pfEnabled
  [out] A reference to a BOOLEAN value that indicates whether the Messaging add-in supports the menu option.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

• S_OK
  Indicates success.

Remarks

A single Command Bar Capability Constant is passed in, and a BOOLEAN value is passed back, which identifies the menu option as either enabled or disabled.

A Messaging add-in must implement the IMessageFormEx2 interface in order to add menu capabilities beyond those in the Standard set of MESSAGEFORMHOST2_CMDBARCAP flags. For information on the extended set of command bar capability constants, see Message Form Host Command Bar Capability Flags.

Requirements

See Also

Reference

IMessageFormEx2
Message Form Host Command Bar Capability Flags
IMessageFormEx