IDirectManipulationViewport::Disable method (directmanipulation.h)

Stops input processing by the viewport.

Syntax

HRESULT Disable();

Return value

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

Remarks

When a viewport is disabled, it immediately stops all transforms and moves the content to the final location.

Call this method when you want to modify multiple attributes atomically. This method can be called at any time.

The viewport will not resume processing input until Enable is called.

Examples

The following example shows how to use this method.

HRESULT hr = pViewport->Disable();

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

See also

IDirectManipulationViewport