IGameInputDispatcher::OpenWaitHandle

Returns a wait handle that signals when work is available in the dispatcher queue.

Syntax

HRESULT OpenWaitHandle(  
         HANDLE* waitHandle  
)  

Parameters

waitHandle   _Outptr_result_nullonfailure_
Type: HANDLE*

The wait handle that is returned.

Return value

Type: HRESULT

Function result

Remarks

The IGameInputDispatcher::OpenWaitHandle returns a wait handle. This method signals when work is available in the dispatcher queue. Call the CloseHandle function on the handle when it is no longer needed. For intermediate and advanced use-cases of the GameInput API, see Advanced GameInput topics.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Overview of GameInput
IGameInputDispatcher