Methods

The methods defined in this section are members of the IVWorks4API interface, which is included in the VWorks software COM implementation.

You can use the following table to quickly locate a VWorks Application Programming Interface method by name or by description.

 

Method	Description	See...
AbortProtocol	Aborts the protocol run that is in progress.	“AbortProtocol method”
CloseProtocol	Closes the specified protocol file.	“CloseProtocol method”
CompileProtocol	Compiles the specified protocol.	“CompileProtocol method”
EnumerateUsers	Returns a list of all users who have VWorks accounts.	“EnumerateUsers method”
GetSimulationMode	Gets the simulation mode state.	“GetSimulationMode method”
GetTipStates	Gets the state of the tipboxes in the specified protocol for automated tip tracking.	“GetTipStates method”
LoadProtocol	Loads the specified protocol for a run.	“LoadProtocol method”
LoadRunsetFile	Loads the specified runset file.	“LoadRunsetFile method”
Login	Logs the specified user in to VWorks using the specified user name and password.	“Login method”
Logout	Ends the current user session when the user logs out.	“Logout method”
PauseProtocol	Pauses the protocol run that is in progress.	“PauseProtocol method”
ReinitializeDevices	Reinitializes all devices in the active device file.	“ReinitializeDevices method”
ResumeProtocol	Resumes the protocol run.	“ResumeProtocol method”
RunProtocol	Runs the specified protocol the specified number of times.	“RunProtocol method”
SetSimulationMode	Turns simulation mode on or off.	“SetSimulationMode method”
ShowDiagsDialog	Displays the Diagnostics window, which contains a list of active devices. The user can select a device from the list and then click a button to display the device’s diagnostics dialog box.	“ShowDiagsDialog method”
ShowLoginDialog	Displays the User Authentication (login) dialog box.	“ShowLoginDialog method”
ShowManageUserDialog	Displays the User Management dialog box.	“ShowManageUserDialog method”
ShowOptionsDialog	Displays the Options dialog box.	“ShowOptionsDialog method”
ShowPlateGroupEditorDialog	Displays the Plate Groups tab in the Inventory Editor.	“ShowPlateGroupEditorDialog method”
ShowTipStateEditor	Displays the Tip State Editor dialog box.	“ShowTipStateEditor method”
ShowVWorks	Displays or hides the VWorks main window.	“ShowVWorks method”