GetStateInteractionContext function

Gets current Interaction Context state and the time when the context will return to idle state.

Syntax


HRESULT WINAPI GetStateInteractionContext(
  _In_   HINTERACTIONCONTEXT interactionContext,
  _In_   const POINTER_INFO *pointerInfo,
  _Out_  INTERACTION_STATE *state
);

Parameters

interactionContext [in]

Pointer to a handle for the Interaction Context.

pointerInfo [in]

Basic pointer information common to all pointer types.

state [out]

One of the constants from INTERACTION_STATE.

Return value

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

Remarks

After interaction ends, the interaction context might still be busy reporting inertia, or expecting second tap in a double tap gesture (in general, if multi-stroke gesture is possible). This function allows the caller to find out when it is safe to treat the Interaction Context object as idle. The main purpose of this function is management of pools of interaction contexts.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Interactioncontext.h

Library

Ninput.lib

DLL

Ninput.dll

See also

Interaction Context Functions
HINTERACTIONCONTEXT

 

 

Community Additions

ADD
Show:
© 2014 Microsoft