query_io_interfaceT_query_io_interfaceQueryIoInterfaceQueryIoInterfacequery_io_interface (Operator)

Name

query_io_interfaceT_query_io_interfaceQueryIoInterfaceQueryIoInterfacequery_io_interface — Query information about the specified I/O device interface.

Signature

query_io_interface( : : IOInterfaceName, Query : Result)

Description

The operator query_io_interfacequery_io_interfaceQueryIoInterfaceQueryIoInterfaceQueryIoInterfacequery_io_interface returns information about the I/O device interface IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameiointerface_name. The desired information is specified via QueryQueryQueryQueryqueryquery. If applicable, ResultResultResultResultresultresult contains a list of supported values.

Generally, when passing the value 'interface_name'"interface_name""interface_name""interface_name""interface_name""interface_name" for QueryQueryQueryQueryqueryquery, all available I/O interfaces are returned. The value of the parameter IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameiointerface_name is ignored in this case.

Please check the directory 'doc/html/reference/io'"doc/html/reference/io""doc/html/reference/io""doc/html/reference/io""doc/html/reference/io""doc/html/reference/io" for documentation about your specific I/O device interface, where all supported interface specific parameters are listed.

Attention

On Windows Systems, error dialog boxes from the operating system can occur when dependency modules of the interface are not found, e.g., the according SDK was not installed. The occurrence of the error boxes can be controlled by setting Windows' Error Mode. Please refer to the description of SetErrorMode within the Windows MSDN documentation.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameiointerface_name (input_control) string → (string)

HALCON I/O interface name.

Default value: []

Suggested values: 'ADLINK-DAQPilot'"ADLINK-DAQPilot""ADLINK-DAQPilot""ADLINK-DAQPilot""ADLINK-DAQPilot""ADLINK-DAQPilot", 'ADLINK-EOS'"ADLINK-EOS""ADLINK-EOS""ADLINK-EOS""ADLINK-EOS""ADLINK-EOS", 'Advantech'"Advantech""Advantech""Advantech""Advantech""Advantech", 'Contec'"Contec""Contec""Contec""Contec""Contec", 'Hilscher-cifX'"Hilscher-cifX""Hilscher-cifX""Hilscher-cifX""Hilscher-cifX""Hilscher-cifX", 'Interface'"Interface""Interface""Interface""Interface""Interface", 'Linux-GPIO'"Linux-GPIO""Linux-GPIO""Linux-GPIO""Linux-GPIO""Linux-GPIO", 'NIDAQmx'"NIDAQmx""NIDAQmx""NIDAQmx""NIDAQmx""NIDAQmx", 'OPC_Classic'"OPC_Classic""OPC_Classic""OPC_Classic""OPC_Classic""OPC_Classic", 'OPC_UA'"OPC_UA""OPC_UA""OPC_UA""OPC_UA""OPC_UA"

QueryQueryQueryQueryqueryquery (input_control) string(-array) → (string)

Parameter name of the query.

Default value: 'io_device_names' "io_device_names" "io_device_names" "io_device_names" "io_device_names" "io_device_names"

Suggested values: 'interface_name'"interface_name""interface_name""interface_name""interface_name""interface_name", 'io_device_names'"io_device_names""io_device_names""io_device_names""io_device_names""io_device_names", 'param_name'"param_name""param_name""param_name""param_name""param_name", 'revision'"revision""revision""revision""revision""revision"

ResultResultResultResultresultresult (output_control) string-array → (string / integer / real)

List of result values (according to QueryQueryQueryQueryqueryquery).

Example (HDevelop)

* Select a suitable i/o device interface of name IOInterfaceName
query_io_interface (IOInterfaceName, 'io_device_names', DeviceNames)
open_io_device (IOInterfaceName, DeviceNames[0], [], [], IODeviceHandle)
query_io_device (IODeviceHandle, [], 'io_channel_names.digital_input', \
                 ChannelInputNames)
open_io_channel (IODeviceHandle, ChannelInputNames[0], [], [], \
                 IOChannelHandle)
read_io_channel (IOChannelHandle, Value, Status)

Result

If the parameters are valid, the operator query_io_interfacequery_io_interfaceQueryIoInterfaceQueryIoInterfaceQueryIoInterfacequery_io_interface returns the value TRUE. If necessary an exception is raised. In this case, an extended error information may be set and can be queried with the operator get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.

Possible Successors

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDeviceopen_io_device

Module

Foundation

Operators