Difference between revisions of "ISInterface:EmulateMousePress"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
Line 1: Line 1:
 
===Syntax===
 
===Syntax===
 
+
*bool EmulateMousePress(unsigned long Button, bool Hold)
 
== Purpose ==
 
== Purpose ==
 
+
To emulate a mouse button being pressed
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===
 
+
*unsigned long Button
 +
:'''[in]''' Which mouse button to press (0 is left, 1 is right)
 +
*bool Hold
 +
:'''[in]''' TRUE if you want to hold the mouse button down, FALSE if you want to press and release
 
=== Return Value ===
 
=== Return Value ===
 
+
*bool
 +
:Returns true on success, false on failure
 
== Examples ==
 
== Examples ==
 
+
===Press the left mouse button and release it===
 +
*pISInterface->EmulateMousePress(0,FALSE);
 +
===Press the right mouse button and hold it===
 +
*pISInterface->EmulateMousePress(1,TRUE);
  
 
== See Also ==
 
== See Also ==
 
* [[ISXDK:ISInterface|ISInterface]]
 
* [[ISXDK:ISInterface|ISInterface]]
 
+
* [[ISInterface:EmulateMouseRelease|EmulateMouseRelease]]
 
[[Category:ISXDK]]
 
[[Category:ISXDK]]
 
[[Category:ISInterface]]
 
[[Category:ISInterface]]

Latest revision as of 23:39, 2 September 2005

Syntax

  • bool EmulateMousePress(unsigned long Button, bool Hold)

Purpose

To emulate a mouse button being pressed

Usage

Parameters

  • unsigned long Button
[in] Which mouse button to press (0 is left, 1 is right)
  • bool Hold
[in] TRUE if you want to hold the mouse button down, FALSE if you want to press and release

Return Value

  • bool
Returns true on success, false on failure

Examples

Press the left mouse button and release it

  • pISInterface->EmulateMousePress(0,FALSE);

Press the right mouse button and hold it

  • pISInterface->EmulateMousePress(1,TRUE);

See Also