User's Reference - DXLInput

### DXLInput

Category

DXLink

Function

Enables a remote DXLink application to set a parameter value in a visual program.

Syntax Available only through the user interface.

Inputs

Name | Type | Default | Description
--- | --- | --- | ---
`default` | value, string, object | no default | default value (overridden by the remote application)

Outputs

Name | Type | Description
--- | --- | ---
`output` | object | the default value or the value sent from a remote application.

Functional Details

This tool receives variable values from a remote application that uses the DXLink library of function calls (see Chapter 17. "DXLink Developer's Toolkit" in IBM Visualization Data Explorer Programmer's Reference). The value received from the application is passed as output from the DXLInput tool.

The module's label (set in the `Notation` field of the Configuration dialog box) is used to establish a global variable, which is then set by the DXLSet... functions of the DXLink development library. One of the parameters of these functions is the global variable name, which must be the same as the label of the DXLInput tool that is intended to receive the value given in the function call. Changing the text of the `Notation` field in DXLInput's configuration dialog box changes the label displayed on the tool's VPE stand-in, just as it does for Receivers and Transmitters.

If there is no remote application setting the default values, DXLInput will output the value specified by `default`. If a remote application sets the value, that value overrides `default`. This parameter provides a mechanism that makes it easier to debug visual programs that are intended to be used and controlled by remote DXLink applications.

Note: The `default` value must be set in the module's configuration dialog box. Any value set by a connection to the output of another tool will not be overridden by a value set by a remote application.

See Also DXLOutput, DXLInputNamed, Input, Output

Chapter 17. "DXLink Developer's Toolkit" in IBM Visualization Data Explorer Programmer's Reference.

[ OpenDX Home at IBM | OpenDX.org ]