IUICommandHandler::Execute method (uiribbon.h)

Responds to execute events on Commands bound to the Command handler.


HRESULT Execute(
  [in]           UINT32               commandId,
  [in]           UI_EXECUTIONVERB     verb,
  [in, optional] const PROPERTYKEY    *key,
  [in, optional] const PROPVARIANT    *currentValue,
  [in, optional] IUISimplePropertySet *commandExecutionProperties


[in] commandId

Type: UINT32

The ID for the Command, which is specified in the Markup resource file.

[in] verb


The UI_EXECUTIONVERB or action that is initiated by the user.

[in, optional] key

Type: const PROPERTYKEY*

A pointer to a Property Key that has changed value. This parameter can be NULL.

[in, optional] currentValue

Type: const PROPVARIANT*

A pointer to the current value for key. This parameter can be NULL.

[in, optional] commandExecutionProperties

Type: IUISimplePropertySet*

A pointer to an IUISimplePropertySet object that contains Command state properties and property values, such as screen coordinates and list item indices. This parameter can be NULL.

Return value


If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.


Each Command in a View must be bound to a new or existing Command handler in the host application.


Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header uiribbon.h
DLL Mshtml.dll

See also


Windows Ribbon Framework Samples