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

Syntax

HRESULT Execute(      
    UINT32 commandId,
    UI_EXECUTIONVERB verb,
    const PROPERTYKEY *key,
    const PROPVARIANT *currentValue,
    IUISimplePropertySet *commandExecutionProperties
);

Parameters

commandId

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

verb

[in]  The UI_EXECUTIONVERB or action that is initiated by the user.

key

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

currentValue

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

commandExecutionProperties

[in]  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

Returns S_OK if successful, or an error value otherwise.

Remarks

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

See Also

Windows Ribbon Framework Samples