CAPTUREHOTKEYCALLBACK Function
#include "l_bitmap.h"
L_INT pEXT_CALLBACK YourFunction (nHotKey, uHotKeyModifiers, pUserData)
|
L_INT nHotKey; |
/* code for HotKey that was pressed */ |
|
L_UINT uHotKeyModifiers; |
/* modifier key */ |
|
/* pointer to additional parameters */ |
Signals that the user has pressed the capture HotKey.
|
Parameter |
Description | |
|
nHotKey |
Key code for activation key. | |
|
uHotKeyModifiers |
Modifier keys used with nHotKey. Possible values are listed below and may be combined. | |
|
|
MOD_ALT |
Alt Key pressed. |
|
|
MOD_CONTROL |
Control key pressed. |
|
|
MOD_SHIFT |
Shift key pressed. |
|
|
0 |
No modifier key was pressed. |
|
pUserData |
Void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of the calling function.) | |
|
|
Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function. | |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Use this callback function to receive notification that the capture HotKey has been pressed by the user. Set this callback using L_CaptureSetHotKeyCallback.
If you do not wish to process the pressed HotKey + Modifiers combination, return ERROR_USER_ABORT.
Example
For an example, refer to L_CaptureSetHotKeyCallback.