IDirectManipulationViewport::RemoveConfiguration method (directmanipulation.h)

Article
02/22/2024

Removes an interaction configuration for the viewport.

Syntax

HRESULT RemoveConfiguration(
  [in] DIRECTMANIPULATION_CONFIGURATION configuration
);

Parameters

[in] configuration

One of the values from DIRECTMANIPULATION_CONFIGURATION that specifies the interaction configuration for the viewport.

Return value

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

Remarks

This method removes a possible configuration that was added by using AddConfiguration. This method can be called only if the configuration is not active.

An interaction configuration specifies how the manipulation engine responds to input and which gestures are supported. Any number of configurations can be added to the viewport using AddConfiguration. Configurations can be switched by the application at runtime using ActivateConfiguration. When a configuration is no longer required (and is not currently active), it can be removed using RemoveConfiguration.

Examples

The following example shows how to use this method.

HRESULT hr = pRegion->RemoveConfiguration(
    DIRECTMANIPULATION_CONFIGURATION_INTERACTION | 
    DIRECTMANIPULATION_CONFIGURATION_TRANSLATION_X);

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	directmanipulation.h

Share via