|
Treehopper C# API
|
Classes | |
| struct | AnimationInfo |
| struct | BlendFunction |
| struct | CreateStruct |
| struct | CursorInfo |
| struct | HardwareInput |
| struct | Input |
| struct | InputPacket |
| struct | KeyboardInput |
| struct | KeyboardInputState |
| struct | KeyState |
| struct | LastInputInfo |
| struct | Message |
| struct | MinimizedMetrics |
| struct | MinMaxInfo |
| struct | MonitorInfo |
| struct | MouseInput |
| struct | NcCalcSizeInput |
| struct | NcCalcSizeOutput |
| struct | NcCalcSizeParams |
| struct | NcCalcSizeRegionUnion |
| struct | PaintStruct |
| struct | TitleBarInfo |
| struct | TrackMouseEventOptions |
| class | User32Helpers |
| class | User32Methods |
| struct | WindowClassEx |
| Note: Marshalled More... | |
| struct | WindowClassExBlittable |
| struct | WindowInfo |
| struct | WindowPlacement |
| struct | WindowPosition |
Functions | |
| delegate IntPtr | WindowProc (IntPtr hwnd, uint msg, IntPtr wParam, IntPtr lParam) |
| delegate bool | EnumWindowsProc (IntPtr hWnd, IntPtr lParam) |
| delegate IntPtr | GetMsgProc (int code, IntPtr wParam, IntPtr lParam) |
| delegate void | TimerProc (IntPtr hWnd, uint uMsg, IntPtr nIdEvent, uint dwTickCountMillis) |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| GW_CHILD | The retrieved handle identifies the child window at the top of the Z order, if the specified window is a parent window; otherwise, the retrieved handle is NULL. The function examines only child windows of the specified window. It does not examine descendant windows. |
| GW_ENABLEDPOPUP | The retrieved handle identifies the enabled popup window owned by the specified window (the search uses the first such window found using GW_HWNDNEXT); otherwise, if there are no enabled popup windows, the retrieved handle is that of the specified window. |
| GW_HWNDFIRST | The retrieved handle identifies the window of the same type that is highest in the Z order. If the specified window is a topmost window, the handle identifies a topmost window. If the specified window is a top-level window, the handle identifies a top-level window. If the specified window is a child window, the handle identifies a sibling window. |
| GW_HWNDLAST | The retrieved handle identifies the window of the same type that is lowest in the Z order. If the specified window is a topmost window, the handle identifies a topmost window. If the specified window is a top-level window, the handle identifies a top-level window. If the specified window is a child window, the handle identifies a sibling window. |
| GW_HWNDNEXT | The retrieved handle identifies the window below the specified window in the Z order. If the specified window is a topmost window, the handle identifies a topmost window. If the specified window is a top-level window, the handle identifies a top-level window. If the specified window is a child window, the handle identifies a sibling window. |
| GW_HWNDPREV | The retrieved handle identifies the window above the specified window in the Z order. If the specified window is a topmost window, the handle identifies a topmost window. If the specified window is a top-level window, the handle identifies a top-level window. If the specified window is a child window, the handle identifies a sibling window. |
| GW_OWNER | The retrieved handle identifies the specified window's owner window, if any. For more information, see Owned Windows. |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| MOD_ALT | Either ALT key was held down. |
| MOD_CONTROL | Either CTRL key was held down. |
| MOD_SHIFT | Either SHIFT key was held down. |
| MOD_WIN | Either WINDOWS key was held down. These keys are labeled with the Windows logo. Hotkeys that involve the Windows key are reserved for use by the operating system. |
|
strong |
|
strong |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| MOD_ALT | Either ALT key must be held down. |
| MOD_CONTROL | Either CTRL key must be held down. |
| MOD_NOREPEAT | Changes the hotkey behavior so that the keyboard auto-repeat does not yield multiple hotkey notifications. Windows Vista: This flag is not supported. |
| MOD_SHIFT | Either SHIFT key must be held down. |
| MOD_WIN | Either WINDOWS key was held down. These keys are labeled with the Windows logo. Keyboard shortcuts that involve the WINDOWS key are reserved for use by the operating system. |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| QS_ALLEVENTS | An input, WM_TIMER, WM_PAINT, WM_HOTKEY, or posted message is in the queue. |
| QS_ALLINPUT | Any message is in the queue. |
| QS_ALLPOSTMESSAGE | A posted message (other than those listed here) is in the queue. |
| QS_HOTKEY | A WM_HOTKEY message is in the queue. |
| QS_INPUT | An input message is in the queue. |
| QS_KEY | A WM_KEYUP, WM_KEYDOWN, WM_SYSKEYUP, or WM_SYSKEYDOWN message is in the queue. |
| QS_MOUSE | A WM_MOUSEMOVE message or mouse-button message (WM_LBUTTONUP, WM_RBUTTONDOWN, and so on). |
| QS_MOUSEBUTTON | A mouse-button message (WM_LBUTTONUP, WM_RBUTTONDOWN, and so on). |
| QS_MOUSEMOVE | A WM_MOUSEMOVE message is in the queue. |
| QS_PAINT | A WM_PAINT message is in the queue. |
| QS_POSTMESSAGE | A posted message (other than those listed here) is in the queue. |
| QS_RAWINPUT | A raw input message is in the queue. For more information, see Raw Input. Windows 2000: This flag is not supported. |
| QS_SENDMESSAGE | A message sent by another thread or application is in the queue. |
| QS_TIMER | A WM_TIMER message is in the queue. |
| QS_REFRESH | |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| SM_ARRANGE | The flags that specify how the system arranged minimized windows. For more information, see the Remarks section in this topic. |
| SM_CLEANBOOT | The value that specifies how the system is started: 0 Normal boot 1 Fail-safe boot 2 Fail-safe with network boot A fail-safe boot (also called SafeBoot, Safe Mode, or Clean Boot) bypasses the user startup files. |
| SM_CMONITORS | The number of display monitors on a desktop. For more information, see the Remarks section in this topic. |
| SM_CMOUSEBUTTONS | The number of buttons on a mouse, or zero if no mouse is installed. |
| SM_CONVERTIBLESLATEMODE | Reflects the state of the laptop or slate mode, 0 for Slate Mode and non-zero otherwise. When this system metric changes, the system sends a broadcast message via WM_SETTINGCHANGE with "ConvertibleSlateMode" in the LPARAM. Note that this system metric doesn't apply to desktop PCs. In that case, use GetAutoRotationState. |
| SM_CXBORDER | The width of a window border, in pixels. This is equivalent to the SM_CXEDGE value for windows with the 3-D look. |
| SM_CXCURSOR | The width of a cursor, in pixels. The system cannot create cursors of other sizes. |
| SM_CXDLGFRAME | This value is the same as SM_CXFIXEDFRAME. |
| SM_CXDOUBLECLK | The width of the rectangle around the location of a first click in a double-click sequence, in pixels. The second click must occur within the rectangle that is defined by SM_CXDOUBLECLK and SM_CYDOUBLECLK for the system to consider the two clicks a double-click. The two clicks must also occur within a specified time. To set the width of the double-click rectangle, call SystemParametersInfo with SPI_SETDOUBLECLKWIDTH. |
| SM_CXDRAG | The number of pixels on either side of a mouse-down point that the mouse pointer can move before a drag operation begins. This allows the user to click and release the mouse button easily without unintentionally starting a drag operation. If this value is negative, it is subtracted from the left of the mouse-down point and added to the right of it. |
| SM_CXEDGE | The width of a 3-D border, in pixels. This metric is the 3-D counterpart of SM_CXBORDER. |
| SM_CXFIXEDFRAME | The thickness of the frame around the perimeter of a window that has a caption but is not sizable, in pixels. SM_CXFIXEDFRAME is the height of the horizontal border, and SM_CYFIXEDFRAME is the width of the vertical border. This value is the same as SM_CXDLGFRAME. |
| SM_CXFOCUSBORDER | The width of the left and right edges of the focus rectangle that the DrawFocusRect draws. This value is in pixels. Windows 2000: This value is not supported. |
| SM_CXFRAME | This value is the same as SM_CXSIZEFRAME. |
| SM_CXFULLSCREEN | The width of the client area for a full-screen window on the primary display monitor, in pixels. To get the coordinates of the portion of the screen that is not obscured by the system taskbar or by application desktop toolbars, call the SystemParametersInfo function with the SPI_GETWORKAREA value. |
| SM_CXHSCROLL | The width of the arrow bitmap on a horizontal scroll bar, in pixels. |
| SM_CXHTHUMB | The width of the thumb box in a horizontal scroll bar, in pixels. |
| SM_CXICON | The default width of an icon, in pixels. The LoadIcon function can load only icons with the dimensions that SM_CXICON and SM_CYICON specifies. |
| SM_CXICONSPACING | The width of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of size SM_CXICONSPACING by SM_CYICONSPACING when arranged. This value is always greater than or equal to SM_CXICON. |
| SM_CXMAXIMIZED | The default width, in pixels, of a maximized top-level window on the primary display monitor. |
| SM_CXMAXTRACK | The default maximum width of a window that has a caption and sizing borders, in pixels. This metric refers to the entire desktop. The user cannot drag the window frame to a size larger than these dimensions. A window can override this value by processing the WM_GETMINMAXINFO message. |
| SM_CXMENUCHECK | The width of the default menu check-mark bitmap, in pixels. |
| SM_CXMENUSIZE | The width of menu bar buttons, such as the child window close button that is used in the multiple document interface, in pixels. |
| SM_CXMIN | The minimum width of a window, in pixels. |
| SM_CXMINIMIZED | The width of a minimized window, in pixels. |
| SM_CXMINSPACING | The width of a grid cell for a minimized window, in pixels. Each minimized window fits into a rectangle this size when arranged. This value is always greater than or equal to SM_CXMINIMIZED. |
| SM_CXMINTRACK | The minimum tracking width of a window, in pixels. The user cannot drag the window frame to a size smaller than these dimensions. A window can override this value by processing the WM_GETMINMAXINFO message. |
| SM_CXPADDEDBORDER | The amount of border padding for captioned windows, in pixels. Windows XP/2000: This value is not supported. |
| SM_CXSCREEN | The width of the screen of the primary display monitor, in pixels. This is the same value obtained by calling GetDeviceCaps as follows: GetDeviceCaps( hdcPrimaryMonitor, HORZRES). |
| SM_CXSIZE | The width of a button in a window caption or title bar, in pixels. |
| SM_CXSIZEFRAME | The thickness of the sizing border around the perimeter of a window that can be resized, in pixels. SM_CXSIZEFRAME is the width of the horizontal border, and SM_CYSIZEFRAME is the height of the vertical border. This value is the same as SM_CXFRAME. |
| SM_CXSMICON | The recommended width of a small icon, in pixels. Small icons typically appear in window captions and in small icon view. |
| SM_CXSMSIZE | The width of small caption buttons, in pixels. |
| SM_CXVIRTUALSCREEN | The width of the virtual screen, in pixels. The virtual screen is the bounding rectangle of all display monitors. The SM_XVIRTUALSCREEN metric is the coordinates for the left side of the virtual screen. |
| SM_CXVSCROLL | The width of a vertical scroll bar, in pixels. |
| SM_CYBORDER | The height of a window border, in pixels. This is equivalent to the SM_CYEDGE value for windows with the 3-D look. |
| SM_CYCAPTION | The height of a caption area, in pixels. |
| SM_CYCURSOR | The height of a cursor, in pixels. The system cannot create cursors of other sizes. |
| SM_CYDLGFRAME | This value is the same as SM_CYFIXEDFRAME. |
| SM_CYDOUBLECLK | The height of the rectangle around the location of a first click in a double-click sequence, in pixels. The second click must occur within the rectangle defined by SM_CXDOUBLECLK and SM_CYDOUBLECLK for the system to consider the two clicks a double-click. The two clicks must also occur within a specified time. To set the height of the double-click rectangle, call SystemParametersInfo with SPI_SETDOUBLECLKHEIGHT. |
| SM_CYDRAG | The number of pixels above and below a mouse-down point that the mouse pointer can move before a drag operation begins. This allows the user to click and release the mouse button easily without unintentionally starting a drag operation. If this value is negative, it is subtracted from above the mouse-down point and added below it. |
| SM_CYEDGE | The height of a 3-D border, in pixels. This is the 3-D counterpart of SM_CYBORDER. |
| SM_CYFIXEDFRAME | The thickness of the frame around the perimeter of a window that has a caption but is not sizable, in pixels. SM_CXFIXEDFRAME is the height of the horizontal border, and SM_CYFIXEDFRAME is the width of the vertical border. This value is the same as SM_CYDLGFRAME. |
| SM_CYFOCUSBORDER | The height of the top and bottom edges of the focus rectangle drawn by DrawFocusRect. This value is in pixels. Windows 2000: This value is not supported. |
| SM_CYFRAME | This value is the same as SM_CYSIZEFRAME. |
| SM_CYFULLSCREEN | The height of the client area for a full-screen window on the primary display monitor, in pixels. To get the coordinates of the portion of the screen not obscured by the system taskbar or by application desktop toolbars, call the SystemParametersInfo function with the SPI_GETWORKAREA value. |
| SM_CYHSCROLL | The height of a horizontal scroll bar, in pixels. |
| SM_CYICON | The default height of an icon, in pixels. The LoadIcon function can load only icons with the dimensions SM_CXICON and SM_CYICON. |
| SM_CYICONSPACING | The height of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of size SM_CXICONSPACING by SM_CYICONSPACING when arranged. This value is always greater than or equal to SM_CYICON. |
| SM_CYKANJIWINDOW | For double byte character set versions of the system, this is the height of the Kanji window at the bottom of the screen, in pixels. |
| SM_CYMAXIMIZED | The default height, in pixels, of a maximized top-level window on the primary display monitor. |
| SM_CYMAXTRACK | The default maximum height of a window that has a caption and sizing borders, in pixels. This metric refers to the entire desktop. The user cannot drag the window frame to a size larger than these dimensions. A window can override this value by processing the WM_GETMINMAXINFO message. |
| SM_CYMENU | The height of a single-line menu bar, in pixels. |
| SM_CYMENUCHECK | The height of the default menu check-mark bitmap, in pixels. |
| SM_CYMENUSIZE | The height of menu bar buttons, such as the child window close button that is used in the multiple document interface, in pixels. |
| SM_CYMIN | The minimum height of a window, in pixels. |
| SM_CYMINIMIZED | The height of a minimized window, in pixels. |
| SM_CYMINSPACING | The height of a grid cell for a minimized window, in pixels. Each minimized window fits into a rectangle this size when arranged. This value is always greater than or equal to SM_CYMINIMIZED. |
| SM_CYMINTRACK | The minimum tracking height of a window, in pixels. The user cannot drag the window frame to a size smaller than these dimensions. A window can override this value by processing the WM_GETMINMAXINFO message. |
| SM_CYSCREEN | The height of the screen of the primary display monitor, in pixels. This is the same value obtained by calling GetDeviceCaps as follows: GetDeviceCaps( hdcPrimaryMonitor, VERTRES). |
| SM_CYSIZE | The height of a button in a window caption or title bar, in pixels. |
| SM_CYSIZEFRAME | The thickness of the sizing border around the perimeter of a window that can be resized, in pixels. SM_CXSIZEFRAME is the width of the horizontal border, and SM_CYSIZEFRAME is the height of the vertical border. This value is the same as SM_CYFRAME. |
| SM_CYSMCAPTION | The height of a small caption, in pixels. |
| SM_CYSMICON | The recommended height of a small icon, in pixels. Small icons typically appear in window captions and in small icon view. |
| SM_CYSMSIZE | The height of small caption buttons, in pixels. |
| SM_CYVIRTUALSCREEN | The height of the virtual screen, in pixels. The virtual screen is the bounding rectangle of all display monitors. The SM_YVIRTUALSCREEN metric is the coordinates for the top of the virtual screen. |
| SM_CYVSCROLL | The height of the arrow bitmap on a vertical scroll bar, in pixels. |
| SM_CYVTHUMB | The height of the thumb box in a vertical scroll bar, in pixels. |
| SM_DBCSENABLED | Nonzero if User32.dll supports DBCS; otherwise, 0. |
| SM_DEBUG | Nonzero if the debug version of User.exe is installed; otherwise, 0. |
| SM_DIGITIZER | Nonzero if the current operating system is Windows 7 or Windows Server 2008 R2 and the Tablet PC Input service is started; otherwise, 0. The return value is a bitmask that specifies the type of digitizer input supported by the device. For more information, see Remarks. Windows Server 2008, Windows Vista, and Windows XP/2000: This value is not supported. |
| SM_IMMENABLED | Nonzero if Input Method Manager/Input Method Editor features are enabled; otherwise, 0. SM_IMMENABLED indicates whether the system is ready to use a Unicode-based IME on a Unicode application. To ensure that a language-dependent IME works, check SM_DBCSENABLED and the system ANSI code page. Otherwise the ANSI-to-Unicode conversion may not be performed correctly, or some components like fonts or registry settings may not be present. |
| SM_MAXIMUMTOUCHES | Nonzero if there are digitizers in the system; otherwise, 0. SM_MAXIMUMTOUCHES returns the aggregate maximum of the maximum number of contacts supported by every digitizer in the system. If the system has only single-touch digitizers, the return value is 1. If the system has multi-touch digitizers, the return value is the number of simultaneous contacts the hardware can provide. Windows Server 2008, Windows Vista, and Windows XP/2000: This value is not supported. |
| SM_MEDIACENTER | Nonzero if the current operating system is the Windows XP, Media Center Edition, 0 if not. |
| SM_MENUDROPALIGNMENT | Nonzero if drop-down menus are right-aligned with the corresponding menu-bar item; 0 if the menus are left-aligned. |
| SM_MIDEASTENABLED | Nonzero if the system is enabled for Hebrew and Arabic languages, 0 if not. |
| SM_MOUSEPRESENT | Nonzero if a mouse is installed; otherwise, 0. This value is rarely zero, because of support for virtual mice and because some systems detect the presence of the port instead of the presence of a mouse. |
| SM_MOUSEHORIZONTALWHEELPRESENT | Nonzero if a mouse with a horizontal scroll wheel is installed; otherwise 0. |
| SM_MOUSEWHEELPRESENT | Nonzero if a mouse with a vertical scroll wheel is installed; otherwise 0. |
| SM_NETWORK | The least significant bit is set if a network is present; otherwise, it is cleared. The other bits are reserved for future use. |
| SM_PENWINDOWS | Nonzero if the Microsoft Windows for Pen computing extensions are installed; zero otherwise. |
| SM_REMOTECONTROL | This system metric is used in a Terminal Services environment to determine if the current Terminal Server session is being remotely controlled. Its value is nonzero if the current session is remotely controlled; otherwise, 0. You can use terminal services management tools such as Terminal Services Manager (tsadmin.msc) and shadow.exe to control a remote session. When a session is being remotely controlled, another user can view the contents of that session and potentially interact with it. |
| SM_REMOTESESSION | This system metric is used in a Terminal Services environment. If the calling process is associated with a Terminal Services client session, the return value is nonzero. If the calling process is associated with the Terminal Services console session, the return value is 0. Windows Server 2003 and Windows XP: The console session is not necessarily the physical console. For more information, see WTSGetActiveConsoleSessionId. |
| SM_SAMEDISPLAYFORMAT | Nonzero if all the display monitors have the same color format, otherwise, 0. Two displays can have the same bit depth, but different color formats. For example, the red, green, and blue pixels can be encoded with different numbers of bits, or those bits can be located in different places in a pixel color value. |
| SM_SECURE | This system metric should be ignored; it always returns 0. |
| SM_SERVERR2 | The build number if the system is Windows Server 2003 R2; otherwise, 0. |
| SM_SHOWSOUNDS | Nonzero if the user requires an application to present information visually in situations where it would otherwise present the information only in audible form; otherwise, 0. |
| SM_SHUTTINGDOWN | Nonzero if the current session is shutting down; otherwise, 0. Windows 2000: This value is not supported. |
| SM_SLOWMACHINE | Nonzero if the computer has a low-end (slow) processor; otherwise, 0. |
| SM_STARTER | Nonzero if the current operating system is Windows 7 Starter Edition, Windows Vista Starter, or Windows XP Starter Edition; otherwise, 0. |
| SM_SWAPBUTTON | Nonzero if the meanings of the left and right mouse buttons are swapped; otherwise, 0. |
| SM_SYSTEMDOCKED | Reflects the state of the docking mode, 0 for Undocked Mode and non-zero otherwise. When this system metric changes, the system sends a broadcast message via WM_SETTINGCHANGE with "SystemDockMode" in the LPARAM. |
| SM_TABLETPC | Nonzero if the current operating system is the Windows XP Tablet PC edition or if the current operating system is Windows Vista or Windows 7 and the Tablet PC Input service is started; otherwise, 0. The SM_DIGITIZER setting indicates the type of digitizer input supported by a device running Windows 7 or Windows Server 2008 R2. For more information, see Remarks. |
| SM_XVIRTUALSCREEN | The coordinates for the left side of the virtual screen. The virtual screen is the bounding rectangle of all display monitors. The SM_CXVIRTUALSCREEN metric is the width of the virtual screen. |
| SM_YVIRTUALSCREEN | The coordinates for the top of the virtual screen. The virtual screen is the bounding rectangle of all display monitors. The SM_CYVIRTUALSCREEN metric is the height of the virtual screen. |
|
strong |
| Enumerator | |
|---|---|
| SPI_GETACCESSTIMEOUT | Retrieves information about the time-out period associated with the accessibility features. The pvParam parameter must point to an ACCESSTIMEOUT structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(ACCESSTIMEOUT). |
| SPI_GETAUDIODESCRIPTION | Determines whether audio descriptions are enabled or disabled. The pvParam parameter is a pointer to an AUDIODESCRIPTION structure. Set the cbSize member of this structure and the uiParam parameter to sizeof(AUDIODESCRIPTION). While it is possible for users who have visual impairments to hear the audio in video content, there is a lot of action in video that does not have corresponding audio. Specific audio description of what is happening in a video helps these users understand the content better. This flag enables you to determine whether audio descriptions have been enabled and in which language. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_GETCLIENTAREAANIMATION | Determines whether animations are enabled or disabled. The pvParam parameter must point to a BOOL variable that receives TRUE if animations are enabled, or FALSE otherwise. Display features such as flashing, blinking, flickering, and moving content can cause seizures in users with photo-sensitive epilepsy. This flag enables you to determine whether such animations have been disabled in the client area. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_GETDISABLEOVERLAPPEDCONTENT | Determines whether overlapped content is enabled or disabled. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE otherwise. Display features such as background images, textured backgrounds, water marks on documents, alpha blending, and transparency can reduce the contrast between the foreground and background, making it harder for users with low vision to see objects on the screen. This flag enables you to determine whether such overlapped content has been disabled. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_GETFILTERKEYS | Retrieves information about the FilterKeys accessibility feature. The pvParam parameter must point to a FILTERKEYS structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(FILTERKEYS). |
| SPI_GETFOCUSBORDERHEIGHT | Retrieves the height, in pixels, of the top and bottom edges of the focus rectangle drawn with DrawFocusRect. The pvParam parameter must point to a UINT value. Windows 2000: This parameter is not supported. |
| SPI_GETFOCUSBORDERWIDTH | Retrieves the width, in pixels, of the left and right edges of the focus rectangle drawn with DrawFocusRect. The pvParam parameter must point to a UINT. Windows 2000: This parameter is not supported. |
| SPI_GETHIGHCONTRAST | Retrieves information about the HighContrast accessibility feature. The pvParam parameter must point to a HIGHCONTRAST structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(HIGHCONTRAST). For a general discussion, see Remarks. |
| SPI_GETLOGICALDPIOVERRIDE | Retrieves a value that determines whether Windows 8 is displaying apps using the default scaling plateau for the hardware or going to the next higher plateau. This value is based on the current "Make everything on your screen bigger" setting, found in the Ease of Access section of PC settings: 1 is on, 0 is off. Apps can provide text and image resources for each of several scaling plateaus: 100%, 140%, and 180%. Providing separate resources optimized for a particular scale avoids distortion due to resizing. Windows 8 determines the appropriate scaling plateau based on a number of factors, including screen size and pixel density. When "Make everything on your screen bigger" is selected (SPI_GETLOGICALDPIOVERRIDE returns a value of 1), Windows uses resources from the next higher plateau. For example, in the case of hardware that Windows determines should use a scale of SCALE_100_PERCENT, this override causes Windows to use the SCALE_140_PERCENT scale value, assuming that it does not violate other constraints. Note You should not use this value. It might be altered or unavailable in subsequent versions of Windows. Instead, use the GetScaleFactorForDevice function or the DisplayProperties class to retrieve the preferred scaling factor. Desktop applications should use desktop logical DPI rather than scale factor. Desktop logical DPI can be retrieved through the GetDeviceCaps function. |
| SPI_GETMESSAGEDURATION | Retrieves the time that notification pop-ups should be displayed, in seconds. The pvParam parameter must point to a ULONG that receives the message duration. Users with visual impairments or cognitive conditions such as ADHD and dyslexia might need a longer time to read the text in notification messages. This flag enables you to retrieve the message duration. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_GETMOUSECLICKLOCK | Retrieves the state of the Mouse ClickLock feature. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE otherwise. For more information, see About Mouse Input. Windows 2000: This parameter is not supported. |
| SPI_GETMOUSECLICKLOCKTIME | Retrieves the time delay before the primary mouse button is locked. The pvParam parameter must point to DWORD that receives the time delay, in milliseconds. This is only enabled if SPI_SETMOUSECLICKLOCK is set to TRUE. For more information, see About Mouse Input. Windows 2000: This parameter is not supported. |
| SPI_GETMOUSEKEYS | Retrieves information about the MouseKeys accessibility feature. The pvParam parameter must point to a MOUSEKEYS structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(MOUSEKEYS). |
| SPI_GETMOUSESONAR | Retrieves the state of the Mouse Sonar feature. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled or FALSE otherwise. For more information, see About Mouse Input. Windows 2000: This parameter is not supported. |
| SPI_GETMOUSEVANISH | Retrieves the state of the Mouse Vanish feature. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled or FALSE otherwise. For more information, see About Mouse Input. Windows 2000: This parameter is not supported. |
| SPI_GETSCREENREADER | Determines whether a screen reviewer utility is running. A screen reviewer utility directs textual information to an output device, such as a speech synthesizer or Braille display. When this flag is set, an application should provide textual information in situations where it would otherwise present the information graphically. The pvParam parameter is a pointer to a BOOLvariable that receives TRUE if a screen reviewer utility is running, or FALSE otherwise. Note Narrator, the screen reader that is included with Windows, does not set the SPI_SETSCREENREADER or SPI_GETSCREENREADER flags. |
| SPI_GETSERIALKEYS | This parameter is not supported. Windows Server 2003 and Windows XP/2000: The user should control this setting through the Control Panel. |
| SPI_GETSHOWSOUNDS | Determines whether the Show Sounds accessibility flag is on or off. If it is on, the user requires an application to present information visually in situations where it would otherwise present the information only in audible form. The pvParam parameter must point to a BOOL variable that receives TRUE if the feature is on, or FALSE if it is off. Using this value is equivalent to calling GetSystemMetrics with SM_SHOWSOUNDS. That is the recommended call. |
| SPI_GETSOUNDSENTRY | Retrieves information about the SoundSentry accessibility feature. The pvParam parameter must point to a SOUNDSENTRY structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(SOUNDSENTRY). |
| SPI_GETSTICKYKEYS | Retrieves information about the StickyKeys accessibility feature. The pvParam parameter must point to a STICKYKEYS structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(STICKYKEYS). |
| SPI_GETTOGGLEKEYS | Retrieves information about the ToggleKeys accessibility feature. The pvParam parameter must point to a TOGGLEKEYS structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(TOGGLEKEYS). |
| SPI_SETACCESSTIMEOUT | Sets the time-out period associated with the accessibility features. The pvParam parameter must point to an ACCESSTIMEOUT structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(ACCESSTIMEOUT). |
| SPI_SETAUDIODESCRIPTION | Turns the audio descriptions feature on or off. The pvParam parameter is a pointer to an AUDIODESCRIPTION structure. While it is possible for users who are visually impaired to hear the audio in video content, there is a lot of action in video that does not have corresponding audio. Specific audio description of what is happening in a video helps these users understand the content better. This flag enables you to enable or disable audio descriptions in the languages they are provided in. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_SETCLIENTAREAANIMATION | Turns client area animations on or off. The pvParam parameter is a BOOL variable. Set pvParam to TRUE to enable animations and other transient effects in the client area, or FALSE to disable them. Display features such as flashing, blinking, flickering, and moving content can cause seizures in users with photo-sensitive epilepsy. This flag enables you to enable or disable all such animations. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_SETDISABLEOVERLAPPEDCONTENT | Turns overlapped content (such as background images and watermarks) on or off. The pvParam parameter is a BOOL variable. Set pvParam to TRUE to disable overlapped content, or FALSE to enable overlapped content. Display features such as background images, textured backgrounds, water marks on documents, alpha blending, and transparency can reduce the contrast between the foreground and background, making it harder for users with low vision to see objects on the screen. This flag enables you to enable or disable all such overlapped content. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_SETFILTERKEYS | Sets the parameters of the FilterKeys accessibility feature. The pvParam parameter must point to a FILTERKEYS structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(FILTERKEYS). |
| SPI_SETFOCUSBORDERHEIGHT | Sets the height of the top and bottom edges of the focus rectangle drawn with DrawFocusRect to the value of the pvParam parameter. Windows 2000: This parameter is not supported. |
| SPI_SETFOCUSBORDERWIDTH | Sets the height of the left and right edges of the focus rectangle drawn with DrawFocusRect to the value of the pvParam parameter. Windows 2000: This parameter is not supported. |
| SPI_SETHIGHCONTRAST | Sets the parameters of the HighContrast accessibility feature. The pvParam parameter must point to a HIGHCONTRAST structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(HIGHCONTRAST). |
| SPI_SETLOGICALDPIOVERRIDE | Do not use. |
| SPI_SETMESSAGEDURATION | Sets the time that notification pop-ups should be displayed, in seconds. The pvParam parameter specifies the message duration. Users with visual impairments or cognitive conditions such as ADHD and dyslexia might need a longer time to read the text in notification messages. This flag enables you to set the message duration. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_SETMOUSECLICKLOCK | Turns the Mouse ClickLock accessibility feature on or off. This feature temporarily locks down the primary mouse button when that button is clicked and held down for the time specified by SPI_SETMOUSECLICKLOCKTIME. The pvParam parameter specifies TRUE for on, or FALSE for off. The default is off. For more information, see Remarks and AboutMouse Input. Windows 2000: This parameter is not supported. |
| SPI_SETMOUSECLICKLOCKTIME | Adjusts the time delay before the primary mouse button is locked. The uiParam parameter should be set to 0. The pvParam parameter points to a DWORD that specifies the time delay in milliseconds. For example, specify 1000 for a 1 second delay. The default is 1200. For more information, see About Mouse Input. Windows 2000: This parameter is not supported. |
| SPI_SETMOUSEKEYS | Sets the parameters of the MouseKeys accessibility feature. The pvParam parameter must point to a MOUSEKEYS structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(MOUSEKEYS). |
| SPI_SETMOUSESONAR | Turns the Sonar accessibility feature on or off. This feature briefly shows several concentric circles around the mouse pointer when the user presses and releases the CTRL key. The pvParam parameter specifies TRUE for on and FALSE for off. The default is off. For more information, see About Mouse Input. Windows 2000: This parameter is not supported. |
| SPI_SETMOUSEVANISH | Turns the Vanish feature on or off. This feature hides the mouse pointer when the user types; the pointer reappears when the user moves the mouse. The pvParam parameter specifies TRUE for on and FALSE for off. The default is off. For more information, see About Mouse Input. Windows 2000: This parameter is not supported. |
| SPI_SETSCREENREADER | Determines whether a screen review utility is running. The uiParam parameter specifies TRUE for on, or FALSE for off. Note Narrator, the screen reader that is included with Windows, does not set the SPI_SETSCREENREADER or SPI_GETSCREENREADER flags. |
| SPI_SETSERIALKEYS | This parameter is not supported. Windows Server 2003 and Windows XP/2000: The user should control this setting through the Control Panel. |
| SPI_SETSHOWSOUNDS | Turns the ShowSounds accessibility feature on or off. The uiParam parameter specifies TRUE for on, or FALSE for off. |
| SPI_SETSOUNDSENTRY | Sets the parameters of the SoundSentry accessibility feature. The pvParam parameter must point to a SOUNDSENTRY structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(SOUNDSENTRY). |
| SPI_SETSTICKYKEYS | Sets the parameters of the StickyKeys accessibility feature. The pvParam parameter must point to a STICKYKEYS structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(STICKYKEYS). |
| SPI_SETTOGGLEKEYS | Sets the parameters of the ToggleKeys accessibility feature. The pvParam parameter must point to a TOGGLEKEYS structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(TOGGLEKEYS). |
|
strong |
| Enumerator | |
|---|---|
| SPI_GETCLEARTYPE | Determines whether ClearType is enabled. The pvParam parameter must point to a BOOL variable that receives TRUE if ClearType is enabled, or FALSE otherwise. ClearType is a software technology that improves the readability of text on liquid crystal display (LCD) monitors. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_GETDESKWALLPAPER | Retrieves the full path of the bitmap file for the desktop wallpaper. The pvParam parameter must point to a buffer to receive the null-terminated path string. Set the uiParam parameter to the size, in characters, of the pvParam buffer. The returned string will not exceed MAX_PATH characters. If there is no desktop wallpaper, the returned string is empty. |
| SPI_GETDROPSHADOW | Determines whether the drop shadow effect is enabled. The pvParam parameter must point to a BOOL variable that returns TRUE if enabled or FALSE if disabled. Windows 2000: This parameter is not supported. |
| SPI_GETFLATMENU | Determines whether native User menus have flat menu appearance. The pvParam parameter must point to a BOOL variable that returns TRUE if the flat menu appearance is set, or FALSE otherwise. Windows 2000: This parameter is not supported. |
| SPI_GETFONTSMOOTHING | Determines whether the font smoothing feature is enabled. This feature uses font antialiasing to make font curves appear smoother by painting pixels at different gray levels. The pvParam parameter must point to a BOOL variable that receives TRUE if the feature is enabled, or FALSE if it is not. |
| SPI_GETFONTSMOOTHINGCONTRAST | Retrieves a contrast value that is used in ClearType smoothing. The pvParam parameter must point to a UINT that receives the information. Valid contrast values are from 1000 to 2200. The default value is 1400. Windows 2000: This parameter is not supported. |
| SPI_GETFONTSMOOTHINGORIENTATION | Retrieves the font smoothing orientation. The pvParam parameter must point to a UINT that receives the information. The possible values are FE_FONTSMOOTHINGORIENTATIONBGR (blue-green-red) and FE_FONTSMOOTHINGORIENTATIONRGB (red-green-blue). Windows XP/2000: This parameter is not supported until Windows XP with SP2. |
| SPI_GETFONTSMOOTHINGTYPE | Retrieves the type of font smoothing. The pvParam parameter must point to a UINT that receives the information. The possible values are FE_FONTSMOOTHINGSTANDARD and FE_FONTSMOOTHINGCLEARTYPE. Windows 2000: This parameter is not supported. |
| SPI_GETWORKAREA | Retrieves the size of the work area on the primary display monitor. The work area is the portion of the screen not obscured by the system taskbar or by application desktop toolbars. The pvParam parameter must point to a RECT structure that receives the coordinates of the work area, expressed in virtual screen coordinates. To get the work area of a monitor other than the primary display monitor, call the GetMonitorInfo function. |
| SPI_SETCLEARTYPE | Turns ClearType on or off. The pvParam parameter is a BOOL variable. Set pvParam to TRUE to enable ClearType, or FALSE to disable it. ClearType is a software technology that improves the readability of text on LCD monitors. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_SETCURSORS | Reloads the system cursors. Set the uiParam parameter to zero and the pvParam parameter to NULL. |
| SPI_SETDESKPATTERN | Sets the current desktop pattern by causing Windows to read the Pattern= setting from the WIN.INI file. |
| SPI_SETDESKWALLPAPER | Note When the SPI_SETDESKWALLPAPER flag is used, SystemParametersInfo returns TRUE unless there is an error (like when the specified file doesn't exist). |
| SPI_SETDROPSHADOW | Enables or disables the drop shadow effect. Set pvParam to TRUE to enable the drop shadow effect or FALSE to disable it. You must also have CS_DROPSHADOW in the window class style. Windows 2000: This parameter is not supported. |
| SPI_SETFLATMENU | Enables or disables flat menu appearance for native User menus. Set pvParam to TRUE to enable flat menu appearance or FALSE to disable it. When enabled, the menu bar uses COLOR_MENUBAR for the menubar background, COLOR_MENU for the menu-popup background, COLOR_MENUHILIGHT for the fill of the current menu selection, and COLOR_HILIGHT for the outline of the current menu selection. If disabled, menus are drawn using the same metrics and colors as in Windows 2000. Windows 2000: This parameter is not supported. |
| SPI_SETFONTSMOOTHING | Enables or disables the font smoothing feature, which uses font antialiasing to make font curves appear smoother by painting pixels at different gray levels. To enable the feature, set the uiParam parameter to TRUE. To disable the feature, set uiParam to FALSE. |
| SPI_SETFONTSMOOTHINGCONTRAST | Sets the contrast value used in ClearType smoothing. The pvParam parameter is the contrast value. Valid contrast values are from 1000 to 2200. The default value is 1400. SPI_SETFONTSMOOTHINGTYPE must also be set to FE_FONTSMOOTHINGCLEARTYPE. Windows 2000: This parameter is not supported. |
| SPI_SETFONTSMOOTHINGORIENTATION | Sets the font smoothing orientation. The pvParam parameter is either FE_FONTSMOOTHINGORIENTATIONBGR (blue-green-red) or FE_FONTSMOOTHINGORIENTATIONRGB (red-green-blue). Windows XP/2000: This parameter is not supported until Windows XP with SP2. |
| SPI_SETFONTSMOOTHINGTYPE | Sets the font smoothing type. The pvParam parameter is either FE_FONTSMOOTHINGSTANDARD, if standard anti-aliasing is used, or FE_FONTSMOOTHINGCLEARTYPE, if ClearType is used. The default is FE_FONTSMOOTHINGSTANDARD. SPI_SETFONTSMOOTHING must also be set. Windows 2000: This parameter is not supported. |
| SPI_SETWORKAREA | Sets the size of the work area. The work area is the portion of the screen not obscured by the system taskbar or by application desktop toolbars. The pvParam parameter is a pointer to a RECT structure that specifies the new work area rectangle, expressed in virtual screen coordinates. In a system with multiple display monitors, the function sets the work area of the monitor that contains the specified rectangle. |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| SPI_GETBEEP | Determines whether the warning beeper is on. The pvParam parameter must point to a BOOL variable that receives TRUE if the beeper is on, or FALSE if it is off. |
| SPI_GETBLOCKSENDINPUTRESETS | Retrieves a BOOL indicating whether an application can reset the screensaver's timer by calling the SendInput function to simulate keyboard or mouse input. The pvParam parameter must point to a BOOL variable that receives TRUE if the simulated input will be blocked, or FALSE otherwise. |
| SPI_GETCONTACTVISUALIZATION | Retrieves the current contact visualization setting. The pvParam parameter must point to a ULONG variable that receives the setting. For more information, see Contact Visualization. |
| SPI_GETDEFAULTINPUTLANG | Retrieves the input locale identifier for the system default input language. The pvParam parameter must point to an HKL variable that receives this value. For more information, see Languages, Locales, and Keyboard Layouts. |
| SPI_GETGESTUREVISUALIZATION | Retrieves the current gesture visualization setting. The pvParam parameter must point to a ULONG variable that receives the setting. For more information, see Gesture Visualization. |
| SPI_GETKEYBOARDCUES | Determines whether menu access keys are always underlined. The pvParam parameter must point to a BOOL variable that receives TRUE if menu access keys are always underlined, and FALSE if they are underlined only when the menu is activated by the keyboard. |
| SPI_GETKEYBOARDDELAY | Retrieves the keyboard repeat-delay setting, which is a value in the range from 0 (approximately 250 ms delay) through 3 (approximately 1 second delay). The actual delay associated with each value may vary depending on the hardware. The pvParam parameter must point to an integer variable that receives the setting. |
| SPI_GETKEYBOARDPREF | Determines whether the user relies on the keyboard instead of the mouse, and wants applications to display keyboard interfaces that would otherwise be hidden. The pvParam parameter must point to a BOOL variable that receives TRUE if the user relies on the keyboard; or FALSE otherwise. |
| SPI_GETKEYBOARDSPEED | Retrieves the keyboard repeat-speed setting, which is a value in the range from 0 (approximately 2.5 repetitions per second) through 31 (approximately 30 repetitions per second). The actual repeat rates are hardware-dependent and may vary from a linear scale by as much as 20%. The pvParam parameter must point to a DWORD variable that receives the setting. |
| SPI_GETMOUSE | Retrieves the two mouse threshold values and the mouse acceleration. The pvParam parameter must point to an array of three integers that receives these values. See mouse_event for further information. |
| SPI_GETMOUSEHOVERHEIGHT | Retrieves the height, in pixels, of the rectangle within which the mouse pointer has to stay for TrackMouseEvent to generate a WM_MOUSEHOVER message. The pvParam parameter must point to a UINT variable that receives the height. |
| SPI_GETMOUSEHOVERTIME | Retrieves the time, in milliseconds, that the mouse pointer has to stay in the hover rectangle for TrackMouseEvent to generate a WM_MOUSEHOVER message. The pvParam parameter must point to a UINT variable that receives the time. |
| SPI_GETMOUSEHOVERWIDTH | Retrieves the width, in pixels, of the rectangle within which the mouse pointer has to stay for TrackMouseEvent to generate a WM_MOUSEHOVER message. The pvParam parameter must point to a UINT variable that receives the width. |
| SPI_GETMOUSESPEED | Retrieves the current mouse speed. The mouse speed determines how far the pointer will move based on the distance the mouse moves. The pvParam parameter must point to an integer that receives a value which ranges between 1 (slowest) and 20 (fastest). A value of 10 is the default. The value can be set by an end-user using the mouse control panel application or by an application using SPI_SETMOUSESPEED. |
| SPI_GETMOUSETRAILS | Determines whether the Mouse Trails feature is enabled. This feature improves the visibility of mouse cursor movements by briefly showing a trail of cursors and quickly erasing them. The pvParam parameter must point to an integer variable that receives a value. if the value is zero or 1, the feature is disabled. If the value is greater than 1, the feature is enabled and the value indicates the number of cursors drawn in the trail. The uiParam parameter is not used. Windows 2000: This parameter is not supported. |
| SPI_GETMOUSEWHEELROUTING | Retrieves the routing setting for wheel button input. The routing setting determines whether wheel button input is sent to the app with focus (foreground) or the app under the mouse cursor. The pvParam parameter must point to a DWORD variable that receives the routing option. If the value is zero or MOUSEWHEEL_ROUTING_FOCUS, mouse wheel input is delivered to the app with focus. If the value is 1 or MOUSEWHEEL_ROUTING_HYBRID (default), mouse wheel input is delivered to the app with focus (desktop apps) or the app under the mouse cursor (Windows Store apps). The uiParam parameter is not used. |
| SPI_GETPENVISUALIZATION | Retrieves the current pen gesture visualization setting. The pvParam parameter must point to a ULONG variable that receives the setting. For more information, see Pen Visualization. |
| SPI_GETSNAPTODEFBUTTON | Determines whether the snap-to-default-button feature is enabled. If enabled, the mouse cursor automatically moves to the default button, such as OK or Apply, of a dialog box. The pvParam parameter must point to a BOOL variable that receives TRUE if the feature is on, or FALSE if it is off. |
| SPI_GETSYSTEMLANGUAGEBAR | Starting with Windows 8: Determines whether the system language bar is enabled or disabled. The pvParam parameter must point to a BOOL variable that receives TRUE if the language bar is enabled, or FALSE otherwise. |
| SPI_GETTHREADLOCALINPUTSETTINGS | Starting with Windows 8: Determines whether the active input settings have Local (per-thread, TRUE) or Global (session, FALSE) scope. The pvParam parameter must point to a BOOL variable. |
| SPI_GETWHEELSCROLLCHARS | Retrieves the number of characters to scroll when the horizontal mouse wheel is moved. The pvParam parameter must point to a UINT variable that receives the number of lines. The default value is 3. |
| SPI_GETWHEELSCROLLLINES | Retrieves the number of lines to scroll when the vertical mouse wheel is moved. The pvParam parameter must point to a UINT variable that receives the number of lines. The default value is 3. |
| SPI_SETBEEP | Turns the warning beeper on or off. The uiParam parameter specifies TRUE for on, or FALSE for off. |
| SPI_SETBLOCKSENDINPUTRESETS | Determines whether an application can reset the screensaver's timer by calling the SendInput function to simulate keyboard or mouse input. The uiParam parameter specifies TRUE if the screensaver will not be deactivated by simulated input, or FALSE if the screensaver will be deactivated by simulated input. |
| SPI_SETCONTACTVISUALIZATION | Sets the current contact visualization setting. The pvParam parameter must point to a ULONG variable that identifies the setting. For more information, see Contact Visualization. Note If contact visualizations are disabled, gesture visualizations cannot be enabled. |
| SPI_SETDEFAULTINPUTLANG | Sets the default input language for the system shell and applications. The specified language must be displayable using the current system character set. The pvParam parameter must point to an HKL variable that contains the input locale identifier for the default language. For more information, see Languages, Locales, and Keyboard Layouts. |
| SPI_SETDOUBLECLICKTIME | Sets the double-click time for the mouse to the value of the uiParam parameter. If the uiParam value is greater than 5000 milliseconds, the system sets the double-click time to 5000 milliseconds. The double-click time is the maximum number of milliseconds that can occur between the first and second clicks of a double-click. You can also call the SetDoubleClickTime function to set the double-click time. To get the current double-click time, call the GetDoubleClickTime function. |
| SPI_SETDOUBLECLKHEIGHT | Sets the height of the double-click rectangle to the value of the uiParam parameter. The double-click rectangle is the rectangle within which the second click of a double-click must fall for it to be registered as a double-click. To retrieve the height of the double-click rectangle, call GetSystemMetrics with the SM_CYDOUBLECLK flag. |
| SPI_SETDOUBLECLKWIDTH | Sets the width of the double-click rectangle to the value of the uiParam parameter. The double-click rectangle is the rectangle within which the second click of a double-click must fall for it to be registered as a double-click. To retrieve the width of the double-click rectangle, call GetSystemMetrics with the SM_CXDOUBLECLK flag. |
| SPI_SETGESTUREVISUALIZATION | Sets the current gesture visualization setting. The pvParam parameter must point to a ULONG variable that identifies the setting. For more information, see Gesture Visualization. Note If contact visualizations are disabled, gesture visualizations cannot be enabled. |
| SPI_SETKEYBOARDCUES | Sets the underlining of menu access key letters. The pvParam parameter is a BOOL variable. Set pvParam to TRUE to always underline menu access keys, or FALSE to underline menu access keys only when the menu is activated from the keyboard. |
| SPI_SETKEYBOARDDELAY | Sets the keyboard repeat-delay setting. The uiParam parameter must specify 0, 1, 2, or 3, where zero sets the shortest delay approximately 250 ms) and 3 sets the longest delay (approximately 1 second). The actual delay associated with each value may vary depending on the hardware. |
| SPI_SETKEYBOARDPREF | Sets the keyboard preference. The uiParam parameter specifies TRUE if the user relies on the keyboard instead of the mouse, and wants applications to display keyboard interfaces that would otherwise be hidden; uiParam is FALSE otherwise. |
| SPI_SETKEYBOARDSPEED | Sets the keyboard repeat-speed setting. The uiParam parameter must specify a value in the range from 0 (approximately 2.5 repetitions per second) through 31 (approximately 30 repetitions per second). The actual repeat rates are hardware-dependent and may vary from a linear scale by as much as 20%. If uiParam is greater than 31, the parameter is set to 31. |
| SPI_SETLANGTOGGLE | Sets the hot key set for switching between input languages. The uiParam and pvParam parameters are not used. The value sets the shortcut keys in the keyboard property sheets by reading the registry again. The registry must be set before this flag is used. the path in the registry is HKEY_CURRENT_USER Layout. Valid values are "1" = ALT+SHIFT, "2" = CTRL+SHIFT, and "3" = none. |
| SPI_SETMOUSE | Sets the two mouse threshold values and the mouse acceleration. The pvParam parameter must point to an array of three integers that specifies these values. See mouse_event for further information. |
| SPI_SETMOUSEBUTTONSWAP | Swaps or restores the meaning of the left and right mouse buttons. The uiParam parameter specifies TRUE to swap the meanings of the buttons, or FALSE to restore their original meanings. To retrieve the current setting, call GetSystemMetrics with the SM_SWAPBUTTON flag. |
| SPI_SETMOUSEHOVERHEIGHT | Sets the height, in pixels, of the rectangle within which the mouse pointer has to stay for TrackMouseEvent to generate a WM_MOUSEHOVER message. Set the uiParam parameter to the new height. |
| SPI_SETMOUSEHOVERTIME | Sets the time, in milliseconds, that the mouse pointer has to stay in the hover rectangle for TrackMouseEvent to generate a WM_MOUSEHOVER message. This is used only if you pass HOVER_DEFAULT in the dwHoverTime parameter in the call to TrackMouseEvent. Set the uiParamparameter to the new time. The time specified should be between USER_TIMER_MAXIMUM and USER_TIMER_MINIMUM. If uiParam is less than USER_TIMER_MINIMUM, the function will use USER_TIMER_MINIMUM. If uiParam is greater than USER_TIMER_MAXIMUM, the function will be USER_TIMER_MAXIMUM. Windows Server 2003 and Windows XP: The operating system does not enforce the use of USER_TIMER_MAXIMUM and USER_TIMER_MINIMUM until Windows Server 2003 with SP1 and Windows XP with SP2. |
| SPI_SETMOUSEHOVERWIDTH | Sets the width, in pixels, of the rectangle within which the mouse pointer has to stay for TrackMouseEvent to generate a WM_MOUSEHOVER message. Set the uiParam parameter to the new width. |
| SPI_SETMOUSESPEED | Sets the current mouse speed. The pvParam parameter is an integer between 1 (slowest) and 20 (fastest). A value of 10 is the default. This value is typically set using the mouse control panel application. |
| SPI_SETMOUSETRAILS | Enables or disables the Mouse Trails feature, which improves the visibility of mouse cursor movements by briefly showing a trail of cursors and quickly erasing them. To disable the feature, set the uiParam parameter to zero or 1. To enable the feature, set uiParam to a value greater than 1 to indicate the number of cursors drawn in the trail. Windows 2000: This parameter is not supported. |
| SPI_SETMOUSEWHEELROUTING | Sets the routing setting for wheel button input. The routing setting determines whether wheel button input is sent to the app with focus (foreground) or the app under the mouse cursor. The pvParam parameter must point to a DWORD variable that receives the routing option. If the value is zero or MOUSEWHEEL_ROUTING_FOCUS, mouse wheel input is delivered to the app with focus. If the value is 1 or MOUSEWHEEL_ROUTING_HYBRID (default), mouse wheel input is delivered to the app with focus (desktop apps) or the app under the mouse cursor (Windows Store apps). Set the uiParam parameter to zero. |
| SPI_SETPENVISUALIZATION | Sets the current pen gesture visualization setting. The pvParam parameter must point to a ULONG variable that identifies the setting. For more information, see Pen Visualization. |
| SPI_SETSNAPTODEFBUTTON | Enables or disables the snap-to-default-button feature. If enabled, the mouse cursor automatically moves to the default button, such as OK or Apply, of a dialog box. Set the uiParam parameter to TRUE to enable the feature, or FALSE to disable it. Applications should use the ShowWindow function when displaying a dialog box so the dialog manager can position the mouse cursor. |
| SPI_SETSYSTEMLANGUAGEBAR | Starting with Windows 8: Turns the legacy language bar feature on or off. The pvParam parameter is a pointer to a BOOL variable. Set pvParam to TRUE to enable the legacy language bar, or FALSE to disable it. The flag is supported on Windows 8 where the legacy language bar is replaced by Input Switcher and therefore turned off by default. Turning the legacy language bar on is provided for compatibility reasons and has no effect on the Input Switcher. |
| SPI_SETTHREADLOCALINPUTSETTINGS | Starting with Windows 8: Determines whether the active input settings have Local (per-thread, TRUE) or Global (session, FALSE) scope. The pvParam parameter must point to a BOOL variable, casted by PVOID. |
| SPI_SETWHEELSCROLLCHARS | Sets the number of characters to scroll when the horizontal mouse wheel is moved. The number of characters is set from the uiParam parameter. |
| SPI_SETWHEELSCROLLLINES | Sets the number of lines to scroll when the vertical mouse wheel is moved. The number of lines is set from the uiParam parameter. The number of lines is the suggested number of lines to scroll when the mouse wheel is rolled without using modifier keys. If the number is 0, then no scrolling should occur. If the number of lines to scroll is greater than the number of lines viewable, and in particular if it is WHEEL_PAGESCROLL (#defined as UINT_MAX), the scroll operation should be interpreted as clicking once in the page down or page up regions of the scroll bar. |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| SPI_GETLOWPOWERACTIVE | This parameter is not supported. Windows Server 2003 and Windows XP/2000: Determines whether the low-power phase of screen saving is enabled. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE if disabled. This flag is supported for 32-bit applications only. |
| SPI_GETLOWPOWERTIMEOUT | This parameter is not supported. Windows Server 2003 and Windows XP/2000: Retrieves the time-out value for the low-power phase of screen saving. The pvParam parameter must point to an integer variable that receives the value. This flag is supported for 32-bit applications only. |
| SPI_GETPOWEROFFACTIVE | This parameter is not supported. When the power-off phase of screen saving is enabled, the GUID_VIDEO_POWERDOWN_TIMEOUT power setting is greater than zero. Windows Server 2003 and Windows XP/2000: Determines whether the power-off phase of screen saving is enabled. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE if disabled. This flag is supported for 32-bit applications only. |
| SPI_GETPOWEROFFTIMEOUT | This parameter is not supported. Instead, check the GUID_VIDEO_POWERDOWN_TIMEOUT power setting. Windows Server 2003 and Windows XP/2000: Retrieves the time-out value for the power-off phase of screen saving. The pvParam parameter must point to an integer variable that receives the value. This flag is supported for 32-bit applications only. |
| SPI_SETLOWPOWERACTIVE | This parameter is not supported. Windows Server 2003 and Windows XP/2000: Activates or deactivates the low-power phase of screen saving. Set uiParam to 1 to activate, or zero to deactivate. The pvParam parameter must be NULL. This flag is supported for 32-bit applications only. |
| SPI_SETLOWPOWERTIMEOUT | This parameter is not supported. Windows Server 2003 and Windows XP/2000: Sets the time-out value, in seconds, for the low-power phase of screen saving. The uiParam parameter specifies the new value. The pvParam parameter must be NULL. This flag is supported for 32-bit applications only. |
| SPI_SETPOWEROFFACTIVE | This parameter is not supported. Instead, set the GUID_VIDEO_POWERDOWN_TIMEOUT power setting. Windows Server 2003 and Windows XP/2000: Activates or deactivates the power-off phase of screen saving. Set uiParam to 1 to activate, or zero to deactivate. The pvParam parameter must be NULL. This flag is supported for 32-bit applications only. |
| SPI_SETPOWEROFFTIMEOUT | This parameter is not supported. Instead, set the GUID_VIDEO_POWERDOWN_TIMEOUT power setting to a time-out value. Windows Server 2003 and Windows XP/2000: Sets the time-out value, in seconds, for the power-off phase of screen saving. The uiParam parameter specifies the new value. The pvParam parameter must be NULL. This flag is supported for 32-bit applications only. |
|
strong |
| Enumerator | |
|---|---|
| SPI_GETSCREENSAVEACTIVE | Determines whether screen saving is enabled. The pvParam parameter must point to a BOOL variable that receives TRUE if screen saving is enabled, or FALSE otherwise. Windows 7, Windows Server 2008 R2, and Windows 2000: The function returns TRUE even when screen saving is not enabled. For more information and a workaround, see KB318781. |
| SPI_GETSCREENSAVERRUNNING | Determines whether a screen saver is currently running on the window station of the calling process. The pvParam parameter must point to a BOOL variable that receives TRUE if a screen saver is currently running, or FALSE otherwise. Note that only the interactive window station, WinSta0, can have a screen saver running. |
| SPI_GETSCREENSAVESECURE | Determines whether the screen saver requires a password to display the Windows desktop. The pvParam parameter must point to a BOOL variable that receives TRUE if the screen saver requires a password, or FALSE otherwise. The uiParam parameter is ignored. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_GETSCREENSAVETIMEOUT | Retrieves the screen saver time-out value, in seconds. The pvParam parameter must point to an integer variable that receives the value. |
| SPI_SETSCREENSAVEACTIVE | Sets the state of the screen saver. The uiParam parameter specifies TRUE to activate screen saving, or FALSE to deactivate it. If the machine has entered power saving mode or system lock state, an ERROR_OPERATION_IN_PROGRESS exception occurs. |
| SPI_SETSCREENSAVESECURE | Sets whether the screen saver requires the user to enter a password to display the Windows desktop. The uiParam parameter is a BOOL variable. The pvParam parameter is ignored. Set uiParam to TRUE to require a password, or FALSE to not require a password. If the machine has entered power saving mode or system lock state, an ERROR_OPERATION_IN_PROGRESS exception occurs. Windows Server 2003 and Windows XP/2000: This parameter is not supported. |
| SPI_SETSCREENSAVETIMEOUT | Sets the screen saver time-out value to the value of the uiParam parameter. This value is the amount of time, in seconds, that the system must be idle before the screen saver activates. If the machine has entered power saving mode or system lock state, an ERROR_OPERATION_IN_PROGRESS exception occurs. |
|
strong |
| Enumerator | |
|---|---|
| SPI_GETHUNGAPPTIMEOUT | Retrieves the number of milliseconds that a thread can go without dispatching a message before the system considers it unresponsive. The pvParam parameter must point to an integer variable that receives the value. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETWAITTOKILLTIMEOUT | Retrieves the number of milliseconds that the system waits before terminating an application that does not respond to a shutdown request. The pvParam parameter must point to an integer variable that receives the value. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETWAITTOKILLSERVICETIMEOUT | Retrieves the number of milliseconds that the service control manager waits before terminating a service that does not respond to a shutdown request. The pvParam parameter must point to an integer variable that receives the value. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETHUNGAPPTIMEOUT | Sets the hung application time-out to the value of the uiParam parameter. This value is the number of milliseconds that a thread can go without dispatching a message before the system considers it unresponsive. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETWAITTOKILLTIMEOUT | Sets the application shutdown request time-out to the value of the uiParam parameter. This value is the number of milliseconds that the system waits before terminating an application that does not respond to a shutdown request. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETWAITTOKILLSERVICETIMEOUT | Sets the service shutdown request time-out to the value of the uiParam parameter. This value is the number of milliseconds that the system waits before terminating a service that does not respond to a shutdown request. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| SPI_GETACTIVEWINDOWTRACKING | Determines whether active window tracking (activating the window the mouse is on) is on or off. The pvParam parameter must point to a BOOL variable that receives TRUE for on, or FALSE for off. |
| SPI_GETACTIVEWNDTRKZORDER | Determines whether windows activated through active window tracking will be brought to the top. The pvParam parameter must point to a BOOL variable that receives TRUE for on, or FALSE for off. |
| SPI_GETACTIVEWNDTRKTIMEOUT | Retrieves the active window tracking delay, in milliseconds. The pvParam parameter must point to a DWORD variable that receives the time. |
| SPI_GETANIMATION | Retrieves the animation effects associated with user actions. The pvParam parameter must point to an ANIMATIONINFO structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(ANIMATIONINFO). |
| SPI_GETBORDER | Retrieves the border multiplier factor that determines the width of a window's sizing border. The pvParamparameter must point to an integer variable that receives this value. |
| SPI_GETCARETWIDTH | Retrieves the caret width in edit controls, in pixels. The pvParam parameter must point to a DWORD variable that receives this value. |
| SPI_GETDOCKMOVING | Determines whether a window is docked when it is moved to the top, left, or right edges of a monitor or monitor array. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE otherwise. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETDRAGFROMMAXIMIZE | Determines whether a maximized window is restored when its caption bar is dragged. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE otherwise. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETDRAGFULLWINDOWS | Determines whether dragging of full windows is enabled. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE otherwise. |
| SPI_GETFOREGROUNDFLASHCOUNT | Retrieves the number of times SetForegroundWindow will flash the taskbar button when rejecting a foreground switch request. The pvParam parameter must point to a DWORD variable that receives the value. |
| SPI_GETFOREGROUNDLOCKTIMEOUT | Retrieves the amount of time following user input, in milliseconds, during which the system will not allow applications to force themselves into the foreground. The pvParam parameter must point to a DWORD variable that receives the time. |
| SPI_GETMINIMIZEDMETRICS | Retrieves the metrics associated with minimized windows. The pvParam parameter must point to a MINIMIZEDMETRICS structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(MINIMIZEDMETRICS). |
| SPI_GETMOUSEDOCKTHRESHOLD | Retrieves the threshold in pixels where docking behavior is triggered by using a mouse to drag a window to the edge of a monitor or monitor array. The default threshold is 1. The pvParam parameter must point to a DWORD variable that receives the value. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETMOUSEDRAGOUTTHRESHOLD | Retrieves the threshold in pixels where undocking behavior is triggered by using a mouse to drag a window from the edge of a monitor or a monitor array toward the center. The default threshold is 20. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETMOUSESIDEMOVETHRESHOLD | Retrieves the threshold in pixels from the top of a monitor or a monitor array where a vertically maximized window is restored when dragged with the mouse. The default threshold is 50. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETNONCLIENTMETRICS | Retrieves the metrics associated with the nonclient area of nonminimized windows. The pvParam parameter must point to a NONCLIENTMETRICS structure that receives the information. Set the cbSize member of this structure and the uiParam parameter to sizeof(NONCLIENTMETRICS). |
| SPI_GETPENDOCKTHRESHOLD | Retrieves the threshold in pixels where docking behavior is triggered by using a pen to drag a window to the edge of a monitor or monitor array. The default is 30. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETPENDRAGOUTTHRESHOLD | Retrieves the threshold in pixels where undocking behavior is triggered by using a pen to drag a window from the edge of a monitor or monitor array toward its center. The default threshold is 30. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETPENSIDEMOVETHRESHOLD | Retrieves the threshold in pixels from the top of a monitor or monitor array where a vertically maximized window is restored when dragged with the mouse. The default threshold is 50. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETSHOWIMEUI | Determines whether the IME status window is visible (on a per-user basis). The pvParam parameter must point to a BOOL variable that receives TRUE if the status window is visible, or FALSE if it is not. |
| SPI_GETSNAPSIZING | Determines whether a window is vertically maximized when it is sized to the top or bottom of a monitor or monitor array. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE otherwise. Use SPI_GETWINARRANGING to determine whether this behavior is enabled. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_GETWINARRANGING | Determines whether window arrangement is enabled. The pvParam parameter must point to a BOOL variable that receives TRUE if enabled, or FALSE otherwise. Window arrangement reduces the number of mouse, pen, or touch interactions needed to move and size top-level windows by simplifying the default behavior of a window when it is dragged or sized. The following parameters retrieve individual window arrangement settings: SPI_GETDOCKMOVING SPI_GETMOUSEDOCKTHRESHOLD SPI_GETMOUSEDRAGOUTTHRESHOLD SPI_GETMOUSESIDEMOVETHRESHOLD SPI_GETPENDOCKTHRESHOLD SPI_GETPENDRAGOUTTHRESHOLD SPI_GETPENSIDEMOVETHRESHOLD SPI_GETSNAPSIZING Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETACTIVEWINDOWTRACKING | Sets active window tracking (activating the window the mouse is on) either on or off. Set pvParam to TRUE for on or FALSE for off. |
| SPI_SETACTIVEWNDTRKZORDER | Determines whether or not windows activated through active window tracking should be brought to the top. Set pvParam to TRUE for on or FALSE for off. |
| SPI_SETACTIVEWNDTRKTIMEOUT | Sets the active window tracking delay. Set pvParam to the number of milliseconds to delay before activating the window under the mouse pointer. |
| SPI_SETANIMATION | Sets the animation effects associated with user actions. The pvParam parameter must point to an ANIMATIONINFO structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(ANIMATIONINFO). |
| SPI_SETBORDER | Sets the border multiplier factor that determines the width of a window's sizing border. The uiParam parameter specifies the new value. |
| SPI_SETCARETWIDTH | Sets the caret width in edit controls. Set pvParam to the desired width, in pixels. The default and minimum value is 1. |
| SPI_SETDOCKMOVING | Sets whether a window is docked when it is moved to the top, left, or right docking targets on a monitor or monitor array. Set pvParam to TRUE for on or FALSE for off. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETDRAGFROMMAXIMIZE | Sets whether a maximized window is restored when its caption bar is dragged. Set pvParam to TRUE for on or FALSE for off. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETDRAGFULLWINDOWS | Sets dragging of full windows either on or off. The uiParam parameter specifies TRUE for on, or FALSE for off. |
| SPI_SETDRAGHEIGHT | Sets the height, in pixels, of the rectangle used to detect the start of a drag operation. Set uiParam to the new value. To retrieve the drag height, call GetSystemMetrics with the SM_CYDRAG flag. |
| SPI_SETDRAGWIDTH | Sets the width, in pixels, of the rectangle used to detect the start of a drag operation. Set uiParam to the new value. To retrieve the drag width, call GetSystemMetrics with the SM_CXDRAG flag. |
| SPI_SETFOREGROUNDFLASHCOUNT | Sets the number of times SetForegroundWindow will flash the taskbar button when rejecting a foreground switch request. Set pvParam to the number of times to flash. |
| SPI_SETFOREGROUNDLOCKTIMEOUT | Sets the amount of time following user input, in milliseconds, during which the system does not allow applications to force themselves into the foreground. Set pvParam to the new time-out value. The calling thread must be able to change the foreground window, otherwise the call fails. |
| SPI_SETMINIMIZEDMETRICS | Sets the metrics associated with minimized windows. The pvParam parameter must point to a MINIMIZEDMETRICS structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(MINIMIZEDMETRICS). |
| SPI_SETMOUSEDOCKTHRESHOLD | Sets the threshold in pixels where docking behavior is triggered by using a mouse to drag a window to the edge of a monitor or monitor array. The default threshold is 1. The pvParam parameter must point to a DWORD variable that contains the new value. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETMOUSEDRAGOUTTHRESHOLD | Sets the threshold in pixels where undocking behavior is triggered by using a mouse to drag a window from the edge of a monitor or monitor array to its center. The default threshold is 20. The pvParam parameter must point to a DWORD variable that contains the new value. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETMOUSESIDEMOVETHRESHOLD | Sets the threshold in pixels from the top of the monitor where a vertically maximized window is restored when dragged with the mouse. The default threshold is 50. The pvParam parameter must point to a DWORD variable that contains the new value. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETNONCLIENTMETRICS | Sets the metrics associated with the nonclient area of nonminimized windows. The pvParam parameter must point to a NONCLIENTMETRICS structure that contains the new parameters. Set the cbSize member of this structure and the uiParam parameter to sizeof(NONCLIENTMETRICS). Also, the lfHeight member of the LOGFONT structure must be a negative value. |
| SPI_SETPENDOCKTHRESHOLD | Sets the threshold in pixels where docking behavior is triggered by using a pen to drag a window to the edge of a monitor or monitor array. The default threshold is 30. The pvParam parameter must point to a DWORD variable that contains the new value. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETPENDRAGOUTTHRESHOLD | Sets the threshold in pixels where undocking behavior is triggered by using a pen to drag a window from the edge of a monitor or monitor array to its center. The default threshold is 30. The pvParam parameter must point to a DWORD variable that contains the new value. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETPENSIDEMOVETHRESHOLD | Sets the threshold in pixels from the top of the monitor where a vertically maximized window is restored when dragged with a pen. The default threshold is 50. The pvParam parameter must point to a DWORD variable that contains the new value. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETSHOWIMEUI | Sets whether the IME status window is visible or not on a per-user basis. The uiParam parameter specifies TRUE for on or FALSE for off. |
| SPI_SETSNAPSIZING | Sets whether a window is vertically maximized when it is sized to the top or bottom of the monitor. Set pvParam to TRUE for on or FALSE for off. SPI_GETWINARRANGING must be TRUE to enable this behavior. Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
| SPI_SETWINARRANGING | Sets whether window arrangement is enabled. Set pvParam to TRUE for on or FALSE for off. Window arrangement reduces the number of mouse, pen, or touch interactions needed to move and size top-level windows by simplifying the default behavior of a window when it is dragged or sized. The following parameters set individual window arrangement settings: SPI_SETDOCKMOVING SPI_SETMOUSEDOCKTHRESHOLD SPI_SETMOUSEDRAGOUTTHRESHOLD SPI_SETMOUSESIDEMOVETHRESHOLD SPI_SETPENDOCKTHRESHOLD SPI_SETPENDRAGOUTTHRESHOLD SPI_SETPENSIDEMOVETHRESHOLD SPI_SETSNAPSIZING Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This parameter is not supported. |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| CS_BYTEALIGNCLIENT | Aligns the window's client area on a byte boundary (in the x direction). This style affects the width of the window and its horizontal placement on the display. |
| CS_BYTEALIGNWINDOW | Aligns the window on a byte boundary (in the x direction). This style affects the width of the window and its horizontal placement on the display. |
| CS_CLASSDC | Allocates one device context to be shared by all windows in the class. Because window classes are process specific, it is possible for multiple threads of an application to create a window of the same class. It is also possible for the threads to attempt to use the device context simultaneously. When this happens, the system allows only one thread to successfully finish its drawing operation. |
| CS_DBLCLKS | Sends a double-click message to the window procedure when the user double-clicks the mouse while the cursor is within a window belonging to the class. |
| CS_DROPSHADOW | Enables the drop shadow effect on a window. The effect is turned on and off through SPI_SETDROPSHADOW. Typically, this is enabled for small, short-lived windows such as menus to emphasize their Z-order relationship to other windows. Windows created from a class with this style must be top-level windows; they may not be child windows. |
| CS_GLOBALCLASS | Indicates that the window class is an application global class. For more information, see the "Application Global Classes" section of About Window Classes. |
| CS_HREDRAW | Redraws the entire window if a movement or size adjustment changes the width of the client area. |
| CS_NOCLOSE | Disables Close on the window menu. |
| CS_OWNDC | Allocates a unique device context for each window in the class. |
| CS_PARENTDC | Sets the clipping rectangle of the child window to that of the parent window so that the child can draw on the parent. A window with the CS_PARENTDC style bit receives a regular device context from the system's cache of device contexts. It does not give the child the parent's device context or device context settings. Specifying CS_PARENTDC enhances an application's performance. |
| CS_SAVEBITS | Saves, as a bitmap, the portion of the screen image obscured by a window of this class. When the window is removed, the system uses the saved bitmap to restore the screen image, including other windows that were obscured. Therefore, the system does not send WM_PAINT messages to windows that were obscured if the memory used by the bitmap has not been discarded and if other screen actions have not invalidated the stored image. This style is useful for small windows (for example, menus or dialog boxes) that are displayed briefly and then removed before other screen activity takes place. This style increases the time required to display the window, because the system must first allocate memory to store the bitmap. |
| CS_VREDRAW | Redraws the entire window if a movement or size adjustment changes the height of the client area. |
|
strong |
| Enumerator | |
|---|---|
| WS_EX_ACCEPTFILES | The window accepts drag-drop files. |
| WS_EX_APPWINDOW | Forces a top-level window onto the taskbar when the window is visible. |
| WS_EX_CLIENTEDGE | The window has a border with a sunken edge. |
| WS_EX_COMPOSITED | Paints all descendants of a window in bottom-to-top painting order using double-buffering. For more information, see Remarks. This cannot be used if the window has a class style of either CS_OWNDC or CS_CLASSDC. Windows 2000: This style is not supported. |
| WS_EX_CONTEXTHELP | The title bar of the window includes a question mark. When the user clicks the question mark, the cursor changes to a question mark with a pointer. If the user then clicks a child window, the child receives a WM_HELP message. The child window should pass the message to the parent window procedure, which should call the WinHelp function using the HELP_WM_HELP command. The Help application displays a pop-up window that typically contains help for the child window. WS_EX_CONTEXTHELP cannot be used with the WS_MAXIMIZEBOX or WS_MINIMIZEBOX styles. |
| WS_EX_CONTROLPARENT | The window itself contains child windows that should take part in dialog box navigation. If this style is specified, the dialog manager recurses into children of this window when performing navigation operations such as handling the TAB key, an arrow key, or a keyboard mnemonic. |
| WS_EX_DLGMODALFRAME | The window has a double border; the window can, optionally, be created with a title bar by specifying the WS_CAPTION style in the dwStyle parameter. |
| WS_EX_LAYERED | The window is a layered window. This style cannot be used if the window has a class style of either CS_OWNDC or CS_CLASSDC. Windows 8: The WS_EX_LAYERED style is supported for top-level windows and child windows. Previous Windows versions support WS_EX_LAYERED only for top-level windows. |
| WS_EX_LAYOUTRTL | If the shell language is Hebrew, Arabic, or another language that supports reading order alignment, the horizontal origin of the window is on the right edge. Increasing horizontal values advance to the left. |
| WS_EX_LEFT | The window has generic left-aligned properties. This is the default. |
| WS_EX_LEFTSCROLLBAR | If the shell language is Hebrew, Arabic, or another language that supports reading order alignment, the vertical scroll bar (if present) is to the left of the client area. For other languages, the style is ignored. |
| WS_EX_LTRREADING | The window text is displayed using left-to-right reading-order properties. This is the default. |
| WS_EX_MDICHILD | The window is a MDI child window. |
| WS_EX_NOACTIVATE | A top-level window created with this style does not become the foreground window when the user clicks it. The system does not bring this window to the foreground when the user minimizes or closes the foreground window. To activate the window, use the SetActiveWindow or SetForegroundWindow function. The window does not appear on the taskbar by default. To force the window to appear on the taskbar, use the WS_EX_APPWINDOW style. |
| WS_EX_NOINHERITLAYOUT | The window does not pass its window layout to its child windows. |
| WS_EX_NOPARENTNOTIFY | The child window created with this style does not send the WM_PARENTNOTIFY message to its parent window when it is created or destroyed. |
| WS_EX_NOREDIRECTIONBITMAP | The window does not render to a redirection surface. This is for windows that do not have visible content or that use mechanisms other than surfaces to provide their visual. |
| WS_EX_OVERLAPPEDWINDOW | The window is an overlapped window. |
| WS_EX_PALETTEWINDOW | The window is palette window, which is a modeless dialog box that presents an array of commands. |
| WS_EX_RIGHT | The window has generic "right-aligned" properties. This depends on the window class. This style has an effect only if the shell language is Hebrew, Arabic, or another language that supports reading-order alignment; otherwise, the style is ignored. Using the WS_EX_RIGHT style for static or edit controls has the same effect as using the SS_RIGHT or ES_RIGHT style, respectively. Using this style with button controls has the same effect as using BS_RIGHT and BS_RIGHTBUTTON styles. |
| WS_EX_RIGHTSCROLLBAR | The vertical scroll bar (if present) is to the right of the client area. This is the default. |
| WS_EX_RTLREADING | If the shell language is Hebrew, Arabic, or another language that supports reading-order alignment, the window text is displayed using right-to-left reading-order properties. For other languages, the style is ignored. |
| WS_EX_STATICEDGE | The window has a three-dimensional border style intended to be used for items that do not accept user input. |
| WS_EX_TOOLWINDOW | The window is intended to be used as a floating toolbar. A tool window has a title bar that is shorter than a normal title bar, and the window title is drawn using a smaller font. A tool window does not appear in the taskbar or in the dialog that appears when the user presses ALT+TAB. If a tool window has a system menu, its icon is not displayed on the title bar. However, you can display the system menu by right-clicking or by typing ALT+SPACE. |
| WS_EX_TOPMOST | The window should be placed above all non-topmost windows and should stay above them, even when the window is deactivated. To add or remove this style, use the SetWindowPos function. |
| WS_EX_TRANSPARENT | The window should not be painted until siblings beneath the window (that were created by the same thread) have been painted. The window appears transparent because the bits of underlying sibling windows have already been painted. To achieve transparency without these restrictions, use the SetWindowRgn function. |
| WS_EX_WINDOWEDGE | The window has a border with a raised edge. |
|
strong |
|
strong |
|
strong |
|
strong |
| Enumerator | |
|---|---|
| SIZE_MAXHIDE | Message is sent to all pop-up windows when some other window is maximized. |
| SIZE_MAXIMIZED | The window has been maximized. |
| SIZE_MAXSHOW | Message is sent to all pop-up windows when some other window has been restored to its former size. |
| SIZE_MINIMIZED | The window has been minimized. |
| SIZE_RESTORED | The window has been resized, but neither the SIZE_MINIMIZED nor SIZE_MAXIMIZED value applies. |
|
strong |
|
strong |
|
strong |
| delegate bool WinApi.User32.EnumWindowsProc | ( | IntPtr | hWnd, |
| IntPtr | lParam | ||
| ) |
| delegate IntPtr WinApi.User32.GetMsgProc | ( | int | code, |
| IntPtr | wParam, | ||
| IntPtr | lParam | ||
| ) |
| delegate void WinApi.User32.TimerProc | ( | IntPtr | hWnd, |
| uint | uMsg, | ||
| IntPtr | nIdEvent, | ||
| uint | dwTickCountMillis | ||
| ) |
| delegate IntPtr WinApi.User32.WindowProc | ( | IntPtr | hwnd, |
| uint | msg, | ||
| IntPtr | wParam, | ||
| IntPtr | lParam | ||
| ) |