{"id":106303,"date":"2022-03-02T07:00:00","date_gmt":"2022-03-02T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=106303"},"modified":"2022-03-02T06:41:12","modified_gmt":"2022-03-02T14:41:12","slug":"20220302-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20220302-00\/?p=106303","title":{"rendered":"How can I detect whether the system has a keyboard attached? On the GetRawInputDeviceList function"},"content":{"rendered":"

Last time, we saw that the instructions for unlocking the PC<\/a> vary depending on whether a keyboard is attached. So how do you detect whether a keyboard is attached?<\/p>\n

The Get\u00adRaw\u00adInput\u00adDevice\u00adList<\/code> function gives you the raw input devices that are registered with the input system. Let’s write a little program to count how many of them are keyboards.<\/p>\n

#include <windows.h>\r\n#include <stdio.h> \/\/ Horrors! Mixing C and C++!\r\n#include <vector>\r\n\r\n[[noreturn]] void throw_win32_error(DWORD error)\r\n{\r\n    \/\/ replace with your desired win32 exception object\r\n    std::terminate();\r\n}\r\n\r\nstd::vector<RAWINPUTDEVICELIST> GetRawInputDevices()\r\n{\r\n  UINT deviceCount = 0;\r\n  if (GetRawInputDeviceList(nullptr, &deviceCount,\r\n            sizeof(devices[0]) != 0) {\r\n    throw_win32_error(GetLastError());\r\n  }\r\n\r\n  std::vector<RAWINPUTDEVICELIST> devices(deviceCount);\r\n  while (deviceCount != 0) {\r\n    UINT actualDeviceCount = GetRawInputDeviceList(\r\n            devices.data(), &deviceCount,\r\n            sizeof(devices[0]);\r\n    if (actualDeviceCount != (UINT)-1) {\r\n        devices.resize(actualDeviceCount);\r\n        return devices;\r\n    }\r\n    DWORD error = GetLastError();\r\n    if (error != ERROR_INSUFFICIENT_BUFFER) {\r\n      throw_win32_error(error);\r\n    }\r\n    devices.resize(deviceCount);\r\n  }\r\n}\r\n<\/pre>\n
The behavior of the Get\u00adRaw\u00adInput\u00adDevice\u00adList()<\/code> is very strange. Here it is in a table:<\/p>\n\n\n\n\n\n\n
Scenario<\/th>\nBuffer pointer<\/th>\nSize on entry<\/th>\nSize on return<\/th>\nReturn value<\/th>\n<\/tr>\n
Query number of devices<\/td>\nnullptr<\/code><\/td>\nignored<\/td>\nrequired size<\/td>\n0<\/td>\n<\/tr>\n
Request data (failed)<\/td>\nNon-nullptr<\/code><\/td>\nprovided size<\/td>\nrequired size<\/td>\n0xFFFFFFFF<\/code><\/td>\n<\/tr>\n
Request data (succeeded)<\/td>\nNon-nullptr<\/code><\/td>\nprovided size<\/td>\nunchanged<\/td>\nactual size<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
The Get\u00adRaw\u00adInput\u00adDevices()<\/code> function starts by using the Query number of devices<\/i> pattern to get an initial guess as to the number of devices, and then goes into the usual loop of calling a function (in this case Get\u00adRaw\u00adInput\u00adDevice\u00adList()<\/code>) to fill a buffer, resizing the buffer based on the result from the previous query, until you finally get what you want. There is a weird edge case where there are no input devices: A vector resized to zero is permitted to return data() == nullptr<\/code>, but that would cause our Request data<\/i> to be misinterpreted as a Query number of devices<\/i>, so we skip the loop if the device count is zero.<\/p>\n
Most people don’t write the loop. They just call the function twice, once to get the count, and once to fill the buffer. But it means that if a device is attached between the two calls, the code fails because the count changed. You need to make it a loop so you can adapt to changes that occur behind your back.<\/p>\n
Other common oversights when using the Get\u00adRaw\u00adInput\u00adDevice\u00adList()<\/code> function are missing the case where there are no devices, or the case where a device is removed during the loop, so that the Request data<\/i> succeeds but returns a value smaller than the provided size.<\/p>\n
If we start with a nonzero initial guess, we can get rid of the preliminary portion of the function and go straight to the loop, thereby avoiding the weird “I’m going to return success even though you didn’t get anything” first row of the above table.<\/p>\n
std::vector<RAWINPUTDEVICELIST> GetRawInputDevices()\r\n{\r\n  UINT deviceCount = 10; \/\/ initial guess, must be nonzero<\/span>\r\n  std::vector<RAWINPUTDEVICELIST> devices(deviceCount);\r\n  while (deviceCount != 0) {\r\n    UINT actualDeviceCount = GetRawInputDeviceList(\r\n            devices.data(), &deviceCount,\r\n            sizeof(devices[0]);\r\n    if (actualDeviceCount != (UINT)-1) {\r\n        devices.resize(actualDeviceCount);\r\n        return devices;\r\n    }\r\n    DWORD error = GetLastError();\r\n    if (error != ERROR_INSUFFICIENT_BUFFER) {\r\n      std::terminate(); \/\/ throw something\r\n    }\r\n    devices.resize(deviceCount);\r\n  }\r\n}\r\n<\/pre>\n
Now we get to use this function to study the raw input devices.<\/p>\n
int main(int argc, char** argv)\r\n{\r\n  auto devices = GetRawInputDevices();\r\n  int mouseCount = 0;\r\n  int keyboardCount = 0;\r\n  int otherCount = 0;\r\n  for (auto const& device : devices) {\r\n    switch (device.dwType)\r\n    {\r\n    case RIM_TYPEKEYBOARD: keyboardCount++; break;\r\n    case RIM_TYPEMOUSE: mouseCount++; break;\r\n    default: otherCount++; break;\r\n    }\r\n  }\r\n  printf(\"There are %d keyboards, %d mice, and %d other things\\n\",\r\n         keyboardCount, mouseCount, otherCount);\r\n  return 0;\r\n}\r\n<\/pre>\n
We walk through the list and tally up how many devices there are of each kind.<\/p>\n
If you just want a “yes or no” answer about whether there is a keyboard attached, you can ask  KeyboardCapabilities.KeyboardPresent<\/code><\/a>:<\/p>\n
#include <stdio.h> \/\/ Horrors! Mixing C and C++!\r\n#include <winrt\/Windows.Devices.Input.h>\r\n\r\nint main(int argc, char** argv)\r\n{\r\n  winrt::init_apartment();\r\n  winrt::Windows::Devices::Input::KeyboardCapabilities capabilities;\r\n  printf(\"KeyboardPresent = %d\\n\", capabilities.KeyboardPresent());\r\n  return 0;\r\n}\r\n<\/pre>\n
The Keyboard\u00adPresent<\/code> property identifies keyboards by\u2026 enumerating the raw input devices and seeing if any of them is a keyboard.<\/p>\n
This all sounds good, except that a lot of devices report themselves as keyboards, even though they aren’t keyboards in the usual sense. Next time, we’ll see if we can filter those guys out.<\/p>\n","protected":false},"excerpt":{"rendered":"
You can enumerate the input devices and see if there’s a keyboard.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-106303","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
You can enumerate the input devices and see if there’s a keyboard.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/106303","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=106303"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/106303\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=106303"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=106303"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=106303"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}