Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

                                                      ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_DOSDEVIOCTL
 
USHORT DosDevIOCtl(pbHotKeyBuf, pcHotKeys, 0x0076, 0x0004, hDevice)
PBYTE pbHotKeyBuf;    /* pointer to structure for hot-key information */
PUSHORT pcHotKeys;    /* pointer to variable for hot-key count        */
HFILE hDevice;        /* device handle                                */
 
The KBD_GETSESMGRHOTKEY function retrieves the hot-key information
structures for the currently defined hot keys.
 
Parameter    Description
────────────────────────────────────────────────────────────────────────────
 
pbHotKeyBuf  Points to the HOTKEY structure that receives hot-key
             information structures. The buffer must be at least as large as
             the number of structures requested.
 
pcHotKeys    Points to the variable that specifies the number of hot-key
             information structures to retrieve. If this variable is
             HOTKEY_MAX_COUNT, the function copies a value to the variable
             that specifies the maximum number of hot keys the keyboard
             device driver can support. If this variable is
             HOTKEY_CURRENT_COUNT, the function copies a value to this
             variable that specifies the actual number of hot keys currently
             supported. The function also copies the hot-key information to
             the buffer pointed to by the pbHotKeyBuf parameter.
 
hDevice      Identifies the keyboard that receives the device-control
             function. The handle must have been created previously by using
             the DosOpen function.
 
Return Value
 
The return value is zero if the function is successful or an error value if
an error occurs.
 
Comments
 
If the variable pointed to by pcHotKeys is HOTKEY_MAX_COUNT, the function
returns the number of currently defined hot keys. The program uses this
number to allocate sufficient space to retrieve the actual hot-key
information (retrieved by setting the variable to HOTKEY_CURRENT_COUNT).
 
Programs should retrieve the number of hot keys first, allocate sufficient
space for the buffer pointed to by the pbHotKeyBuf parameter, then retrieve
the hot keys.
 
See Also
 
DosOpen, KBD_SETSESMGRHOTKEY, HOTKEY
 
                                      ♦