GetPropertyInteractionContext function

Gets Interaction Context object properties.

Syntax


HRESULT WINAPI GetPropertyInteractionContext(
  _In_   HINTERACTIONCONTEXT interactionContext,
  _In_   INTERACTION_CONTEXT_PROPERTY contextProperty,
  _Out_  UINT32 *value
);

Parameters

interactionContext [in]

Handle to the Interaction Context object.

contextProperty [in]

One of the constants identified by INTERACTION_CONTEXT_PROPERTY.

value [out]

The value of the property.

Valid values for contextProperty are:

INTERACTION_CONTEXT_PROPERTY_MEASUREMENT_UNITS Meaning
INTERACTION_CONTEXT_PROPERTY_MEASUREMENT_UNITS_HIMETRIC
0

Measurement units are HIMETRIC units (0.01 mm).

INTERACTION_CONTEXT_PROPERTY_MEASUREMENT_UNITS_SCREEN
1

Measurement units are screen pixels. This is the default value.

 

INTERACTION_CONTEXT_PROPERTY_UI_FEEDBACK Meaning
INTERACTION_CONTEXT_PROPERTY_UI_FEEDBACK_OFF
0

Visual feedback for user interactions is disabled (the caller is responsible for displaying visual feedback). For more info, see Input Feedback Configuration.

INTERACTION_CONTEXT_PROPERTY_UI_FEEDBACK_ON
1

Visual feedback for user interactions is enabled. This is the default value. For more info, see Input Feedback Configuration.

 

INTERACTION_CONTEXT_PROPERTY_FILTER_POINTERSMeaning
INTERACTION_CONTEXT_PROPERTY_FILTER_POINTERS_OFF
0

Pointer filtering is disabled (all pointer input data is processed).

INTERACTION_CONTEXT_PROPERTY_FILTER_POINTERS_ON
1

Pointer filtering is enabled (only pointers specified through AddPointerInteractionContext are processed). This is the default value.

 

Return value

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

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

None supported

Header

Interactioncontext.h

Library

Ninput.lib

DLL

Ninput.dll

See also

Interaction Context Functions
SetPropertyInteractionContext
HINTERACTIONCONTEXT

 

 

Community Additions

ADD
Show:
© 2014 Microsoft