Responds to property update requests from the Windows Ribbon (Ribbon) framework.

Syntax

HRESULT UpdateProperty(      
    UINT32 commandId,
    REFPROPERTYKEY key,
    const PROPVARIANT *currentValue,
    PROPVARIANT *newValue
);

Parameters

commandId

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

key

[in]  The Property Key to update.

currentValue

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

newValue

[out]  When this method returns, contains a pointer to the new value for key.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method should be allowed to return before any subsequent calls to the Ribbon framework are made.

The values of Command properties, such as UI_PKEY_Enabled or UI_PKEY_Label, are set through calls to IUIFramework::SetUICommandProperty or IUIFramework::InvalidateUICommand.

See Also

Windows Ribbon Framework Samples