ClassesClassesClassesClasses | | | | Operators

query_io_interfaceT_query_io_interfaceQueryIoInterfacequery_io_interfaceQueryIoInterfaceQueryIoInterface (Operator)

Name

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

Signature

query_io_interface( : : IOInterfaceName, Query : Result)

Herror T_query_io_interface(const Htuple IOInterfaceName, const Htuple Query, Htuple* Result)

Herror query_io_interface(const HTuple& IOInterfaceName, const HTuple& Query, HTuple* Result)

HTuple HIODevice::QueryIoInterface(const HTuple& IOInterfaceName, const HTuple& Query)

void QueryIoInterface(const HTuple& IOInterfaceName, const HTuple& Query, HTuple* Result)

static HTuple HIODevice::QueryIoInterface(const HString& IOInterfaceName, const HTuple& Query)

static HTuple HIODevice::QueryIoInterface(const HString& IOInterfaceName, const HString& Query)

static HTuple HIODevice::QueryIoInterface(const char* IOInterfaceName, const char* Query)

void HOperatorSetX.QueryIoInterface(
[in] VARIANT IOInterfaceName, [in] VARIANT Query, [out] VARIANT* Result)

VARIANT HIODeviceX.QueryIoInterface(
[in] BSTR IOInterfaceName, [in] VARIANT Query)

static void HOperatorSet.QueryIoInterface(HTuple IOInterfaceName, HTuple query, out HTuple result)

static HTuple HIODevice.QueryIoInterface(string IOInterfaceName, HTuple query)

static HTuple HIODevice.QueryIoInterface(string IOInterfaceName, string query)

Description

The operator query_io_interfacequery_io_interfaceQueryIoInterfacequery_io_interfaceQueryIoInterfaceQueryIoInterface returns information about the I/O device interface IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceName. 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 IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceName 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.

Parallelization

Parameters

IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceName (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

HALCON I/O interface name.

Default value: []

Suggested values: 'Advantech'"Advantech""Advantech""Advantech""Advantech""Advantech", 'Contec'"Contec""Contec""Contec""Contec""Contec", 'Interface'"Interface""Interface""Interface""Interface""Interface", '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) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

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: 'revision'"revision""revision""revision""revision""revision", '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"

ResultResultResultResultResultresult (output_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double) (BSTR / Hlong / double) (char* / Hlong / double)

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_interfaceQueryIoInterfacequery_io_interfaceQueryIoInterfaceQueryIoInterface returns the value 2 (H_MSG_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_infoGetExtendedErrorInfoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfo.

Possible Successors

open_io_deviceopen_io_deviceOpenIoDeviceopen_io_deviceOpenIoDeviceOpenIoDevice

Module

Foundation


ClassesClassesClassesClasses | | | | Operators