Edit

IDirectManipulationViewport::GetStatus method (directmanipulation.h)

  • Article

Gets the state of the viewport.

Syntax

HRESULT GetStatus(
  [out, retval] DIRECTMANIPULATION_STATUS *status
);

Parameters

[out, retval] status

One of the values from DIRECTMANIPULATION_STATUS.

Return value

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

Remarks

This method returns the viewport state at the time of the call and not at the time when the return value is read.

This method will fail if called after Abandon.

Examples

The following example shows how to use this method.

DIRECTMANIPULATION_STATUS status;

HRESULT hr = pViewport->GetStatus(&status);

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