ClickButton method of the Msvm_SyntheticMouse class
Simulates a button click, a down-up sequence, on the specified device button.
Syntax
uint32 ClickButton(
[in] uint32 buttonIndex
);
Parameters
-
buttonIndex [in]
-
Type: uint32
The 1-based index of the button.
Return value
Type: uint32
A return value of zero indicates success. A nonzero value indicates a failure to modify the button state.
-
Completed with No Error (0)
-
Method Parameters Checked - Job Started (4096)
-
Failed (32768)
-
Access Denied (32769)
-
Not Supported (32770)
-
Status is unknown (32771)
-
Timeout (32772)
-
Invalid parameter (32773)
-
System is in used (32774)
-
Invalid state for this operation (32775)
-
Incorrect data type (32776)
-
System is not available (32777)
-
Out of memory (32778)
Remarks
Access to the Msvm_SyntheticMouse class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.
Examples
The following C# sample simulates a button click. The referenced utilities can be found in Common Utilities for the Virtualization Samples.
using System;
using System.Management;
namespace HyperVSamples
{
class ClickButtonClass
{
static ManagementObject GetComputerMouse(ManagementObject vm)
{
ManagementObjectCollection mouseCollection = vm.GetRelated
(
"Msvm_SyntheticMouse",
"Msvm_SystemDevice",
null,
null,
"PartComponent",
"GroupComponent",
false,
null
);
ManagementObject mouse = null;
foreach (ManagementObject instance in mouseCollection)
{
mouse = instance;
break;
}
return mouse;
}
static ManagementObject GetVideoHead(ManagementObject vm)
{
ManagementObjectCollection videoControllers = vm.GetRelated
(
"Msvm_SyntheticDisplayController",
"Msvm_SystemDevice",
null,
null,
"PartComponent",
"GroupComponent",
false,
null
);
ManagementObject videoController = null;
foreach (ManagementObject instance in videoControllers)
{
videoController = instance;
break;
}
ManagementObjectCollection videoHeads = videoController.GetRelated
(
"Msvm_VideoHead",
"Msvm_VideoHeadOnController",
null,
null,
"Dependent",
"Antecedent",
false,
null
);
ManagementObject videoHead = null;
foreach (ManagementObject instance in videoHeads)
{
videoHead = instance;
break;
}
videoController.Dispose();
return videoHead;
}
static bool SetMousePosition(ManagementObject mouse, ManagementObject video)
{
bool passed = false;
ManagementBaseObject inParams = mouse.GetMethodParameters("setAbsolutePosition");
inParams["horizontalPosition"] = 1;
inParams["verticalPosition"] = Convert.ToInt32(video["CurrentVerticalResolution"]) - 1;
ManagementBaseObject outParams = mouse.InvokeMethod("setAbsolutePosition", inParams, null);
if ((UInt16)outParams["ReturnValue"] == ReturnCode.Completed)
{
Console.WriteLine("Mouse position is set at (1,{0})", inParams["verticalPosition"]);
passed = true;
}
else
{
Console.WriteLine("setAbsolutePosition operation failed with {0} error.", outParams["ReturnValue"]);
}
inParams.Dispose();
outParams.Dispose();
return passed;
}
static void ClickButton(string vmName, int buttonIndex)
{
ManagementScope scope = new ManagementScope(@"root\virtualization", null);
ManagementObject vm = Utility.GetTargetComputer(vmName, scope);
ManagementObject videoHead = GetVideoHead(vm);
ManagementObject mouse = GetComputerMouse(vm);
if (!SetMousePosition(mouse, videoHead))
{
return;
}
ManagementBaseObject inParams = mouse.GetMethodParameters("ClickButton");
inParams["buttonIndex"] = buttonIndex;
ManagementBaseObject outParams = mouse.InvokeMethod("ClickButton", inParams, null);
if ((UInt16)outParams["ReturnValue"] == ReturnCode.Completed)
{
string.Format("Button {0} was clicked on {1}", buttonIndex, vm["ElementName"]);
}
else
{
string.Format("Unable to click button {0}' on {1}", buttonIndex, vm["ElementName"]);
}
inParams.Dispose();
outParams.Dispose();
mouse.Dispose();
vm.Dispose();
}
static void Main(string[] args)
{
if (args != null && args.Length != 2)
{
Console.WriteLine("Usage: ClickButton vmName buttonIndex");
return;
}
ClickButton(args[0], Convert.ToInt32(args[1]));
}
}
}
The following VBScript sample simulates a button click.
option explicit
dim objWMIService
dim fileSystem
const wmiSuccessful = 0
Main()
'-----------------------------------------------------------------
' Main routine
'-----------------------------------------------------------------
Sub Main()
dim vmName, computer, objArgs, mouse, video, computerSystem, buttonIndex
set fileSystem = Wscript.CreateObject("Scripting.FileSystemObject")
computer = "."
set objWMIService = GetObject("winmgmts:\\" & computer & "\root\virtualization")
set objArgs = WScript.Arguments
if WScript.Arguments.Count = 2 then
vmName= objArgs.Unnamed.Item(0)
buttonIndex = objArgs.Unnamed.Item(1)
else
WScript.Echo "usage: cscript ClickButton.vbs vmName buttonIndex"
WScript.Quit
end if
set computerSystem = GetComputerSystem(vmName)
set mouse = GetComputerMouse(computerSystem)
set video = GetComputerVideoHead(computerSystem)
if ClickButton(mouse, buttonIndex, video) then
WriteLog "Done"
WScript.Quit(0)
else
WriteLog "ClickButton failed"
WScript.Quit(1)
end if
End Sub
'-----------------------------------------------------------------
' Retrieve Msvm_VirtualComputerSystem from base on its ElementName
'-----------------------------------------------------------------
Function GetComputerSystem(vmElementName)
On Error Resume Next
dim query
query = Format1("select * from Msvm_ComputerSystem where ElementName = '{0}'", vmElementName)
set GetComputerSystem = objWMIService.ExecQuery(query).ItemIndex(0)
if (Err.Number <> 0) then
WriteLog Format1("Err.Number: {0}", Err.Number)
WriteLog Format1("Err.Description:{0}",Err.Description)
WScript.Quit(1)
end if
End Function
'-----------------------------------------------------------------
' Retrieve Msvm_SyntheticMouse from given computer system
'-----------------------------------------------------------------
Function GetComputerMouse(computerSystem)
On Error Resume Next
dim query
query = Format1("ASSOCIATORS OF {{0}} WHERE resultClass = Msvm_SyntheticMouse", computerSystem.Path_.Path)
set GetComputerMouse = objWMIService.ExecQuery(query).ItemIndex(0)
if (Err.Number <> 0) then
WriteLog Format1("Err.Number: {0}", Err.Number)
WriteLog Format1("Err.Description:{0}",Err.Description)
WScript.Quit(1)
end if
End Function
'-----------------------------------------------------------------
' Retrieve Msvm_VideoHead from given computer system
'-----------------------------------------------------------------
Function GetComputerVideoHead(computerSystem)
On Error Resume Next
dim query, controller
query = Format1("ASSOCIATORS OF {{0}} WHERE resultClass = Msvm_SyntheticDisplayController", computerSystem.Path_.Path)
set controller = objWMIService.ExecQuery(query).ItemIndex(0)
if (Err.Number <> 0) then
WriteLog Format1("Err.Number: {0}", Err.Number)
WriteLog Format1("Err.Description:{0}",Err.Description)
WScript.Quit(1)
end if
query = Format1("ASSOCIATORS OF {{0}} WHERE resultClass = Msvm_VideoHead", controller.Path_.Path)
set GetComputerVideoHead = objWMIService.ExecQuery(query).ItemIndex(0)
if (Err.Number <> 0) then
WriteLog Format1("Err.Number: {0}", Err.Number)
WriteLog Format1("Err.Description:{0}",Err.Description)
WScript.Quit(1)
end if
End Function
'-----------------------------------------------------------------
' set mouse relative position on a virtual machine
'-----------------------------------------------------------------
Function setAbsolutePosition(mouse, video)
WriteLog Format1("setAbsolutePosition({0})", mouse.ElementName)
dim objInParam, objOutParams
setAbsolutePosition = false
set objInParam = mouse.Methods_("setAbsolutePosition").InParameters.SpawnInstance_()
objInParam.horizontalPosition = 1
objInParam.verticalPosition = video.CurrentVerticalResolution - 1
set objOutParams = mouse.ExecMethod_("setAbsolutePosition", objInParam)
if objOutParams.ReturnValue = wmiSuccessful then
WriteLog Format1("Mouse position is set at (1,{0})", objInParam.verticalPosition)
setAbsolutePosition = true
end if
End Function
'-----------------------------------------------------------------
' Click mouse on a virtual machine
'-----------------------------------------------------------------
Function ClickButton(mouse, buttonIndex, video)
WriteLog Format2("ClickButton({0}, {1})", mouse.ElementName, buttonIndex)
dim objInParam, objOutParams
ClickButton = false
if Not setAbsolutePosition(mouse, video) then
Exit Function
end if
set objInParam = mouse.Methods_("ClickButton").InParameters.SpawnInstance_()
objInParam.buttonIndex = buttonIndex
set objOutParams = mouse.ExecMethod_("ClickButton", objInParam)
if objOutParams.ReturnValue = wmiSuccessful then
WriteLog Format2("{0} button {1} was clicked.", mouse.ElementName, buttonIndex)
ClickButton = true
end if
End Function
'-----------------------------------------------------------------
' Create the console log files.
'-----------------------------------------------------------------
Sub WriteLog(line)
dim fileStream
set fileStream = fileSystem.OpenTextFile(".\clickButton.log", 8, true)
WScript.Echo line
fileStream.WriteLine line
fileStream.Close
End Sub
'------------------------------------------------------------------------------
' The string formatting functions to avoid string concatenation.
'------------------------------------------------------------------------------
Function Format2(myString, arg0, arg1)
Format2 = Format1(myString, arg0)
Format2 = Replace(Format2, "{1}", arg1)
End Function
'------------------------------------------------------------------------------
' The string formatting functions to avoid string concatenation.
'------------------------------------------------------------------------------
Function Format1(myString, arg0)
Format1 = Replace(myString, "{0}", arg0)
End Function
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| End of client support |
None supported |
| End of server support |
Windows Server 2012 |
| Namespace |
Root\Virtualization |
| MOF |
|