Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Stops a callback function from being triggered.
Syntax
void StopCallback(
GameInputCallbackToken callbackToken
);
Parameters
callbackToken _In_
Type: GameInputCallbackToken
Token for the callback function to be stopped. Generated when the function was initially registered with IGameInput::RegisterDeviceCallback.
Return value
Type: void
No return value.
Remarks
This function differs from the IGameInput::UnregisterCallback function in that it does not make it safe for you to remove resources from the callback function, it can however be called from the callback function.
The StopCallback method and IGameInput::UnregisterCallback methods differ slightly. Calling either method ensures that the associated callback will not be dispatched again. However, it is not safe to free any resources associated with the callback (for example, unloading the DLL that hosts the callback function) until the IGameInput::UnregisterCallback function successfully returns. Therefore, it is not possible to unregister a callback from within its registered callback function, and attempting to do so will trigger a fatal assert. However, it is safe to cancel a callback from within the callback function.
Requirements
Header: GameInput.h
Library: gameinput.lib
Supported platforms: Windows
See also
Input API Overview IGameInput IGameInput::RegisterDeviceCallback IGameInput::RegisterReadingCallback IGameInput::RegisterSystemButtonCallback