You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.5 Help

Returns data about the device connected to the computer. The data type you wire to the device ID input determines the polymorphic instance to use.

(Windows) You must have DirectX 8.0 or later to use this VI.

Example

Use the pull-down menu to select an instance of this VI.

Select an instance joystickAcquirekeyboardAcquiremouseAcquire

joystickAcquire

	device ID identifies which device to acquire data from.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	device ID identifies which device you acquired data from.
	axis info contains numeric values for the axes. The number of axes depend on the specific joystick. X axis is the numeric value of the x-axis. Y axis is the numeric value of the y-axis. Z axis is the numeric value of the z-axis. X axis rotation is the numeric value of the x-axis rotation. Y axis rotation is the numeric value of the y-axis rotation. Z axis rotation is the numeric value of the z-axis rotation (rudder). U axis is the numeric value of the u-axis. V axis is the numeric value for the v-axis.
	button info contains Boolean values for up to 32 buttons. A TRUE value indicates that the button was pressed when the VI ran.
	direction info contains numeric values for up to four points of view.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

keyboardAcquire

	device ID identifies which device to acquire data from.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	device ID identifies which device you acquired data from.
	keys pressed indicates which keys were pressed when the VI ran. This parameter returns values associated only with US keyboards.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

mouseAcquire

	device ID identifies which device to acquire data from.
	key mode determines the key mode to use. 0 Relative—Defines the mouse coordinates as relative to the last time you called the VI. 1 Absolute—Defines the mouse coordinates (axis info) as absolute coordinates relative to the upper left hand corner of the screen.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	device ID identifies which device you acquired data from.
	axis info contains the numeric value for axes. Horizontal is the numeric value of the horizontal axis. Vertical is the numeric value of the vertical axis. Scrolling is the numeric value of the scrolling axis if the mouse supports it.
	button info contains Boolean values for up to four buttons. A TRUE value indicates that the button was pressed when the VI ran.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Example

Refer to the Basic Input Demo VI in the labview\examples\input\InputDemo.llb for an example of using the Acquire Input Data VI.