OptimizedHotkey Property

Gets or sets a flag that indicates whether to optimize HotKey processing.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public bool OptimizedHotkey {get; set;}

'Declaration
 
Public Property OptimizedHotkey As Boolean

'Usage
 
Dim instance As ScreenCaptureOptions
Dim value As Boolean
 
instance.OptimizedHotkey = value
 
value = instance.OptimizedHotkey

public bool OptimizedHotkey {get; set;}

 get_OptimizedHotkey();
 set_OptimizedHotkey(value);

public:
property bool OptimizedHotkey {
   bool get();
   void set (    bool value);
}

Property Value

If true, HotKey processing uses a global system hook. Otherwise, normal hot key processing is performed.

Remarks

Normally, when a capture function is called, the function enters a loop, and waits for the HotKey specified in nHotKey to be pressed, at which point it performs the capture. This loop can cause the CPU usage indicator to appear maxed out. Specifying the OptimizedHotkey property to be true will cause the capture method to return immediately (if a HotKey has been specified in Hotkey). In this case, a global system HotKey hook is established and used to wait for the HotKey to be pressed. When the HotKey is pressed, the capture is performed and the event handler is called with the results of the capture. Use this option only if the normal behavior is causing your application problems. This option is ignored in Win95/98/Me.

Example

For an example, refer to ScreenCaptureEngine.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ScreenCaptureOptions Structure
ScreenCaptureOptions Members