ssCore.Mouse.releaseCapture

Releases mouse input capturing enabled by a previous call to Mouse.setCapture.


Availability:

First available in version 3.8 build 333.


Input Parameters:

None.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Mouse.releaseCapture( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Mouse.releaseCapture( paramsObject );


Notes:

None.


Examples:

// some common window handles
ssDebug.trace("main app HWND: " + ssGlobals.ssHWND);
ssDebug.trace("Flash HWND: " + ssGlobals.ssFlashHWND);

// where is mouse input going?
var r:Object = ssCore.Mouse.getCapture({});
ssDebug.trace("mouse currently captured by: " + r.result);

// redirect mouse input to our main application window
var r:Object = ssCore.Mouse.setCapture({});
ssDebug.trace("setCapture: " + r.success);

// check mouse capture again
var r:Object = ssCore.Mouse.getCapture({});
ssDebug.trace("mouse currently captured by: " + r.result);

// release captured mouse input
var r:Object = ssCore.Mouse.releaseCapture({});
ssDebug.trace("releaseCapture: " + r.success);

// check mouse capture again
var r:Object = ssCore.Mouse.getCapture({});
ssDebug.trace("mouse currently captured by: " + r.result);