ClassesClassesClassesClasses | | | | Operators

query_io_deviceT_query_io_deviceQueryIoDevicequery_io_deviceQueryIoDeviceQueryIoDevice (Operator)

Name

query_io_deviceT_query_io_deviceQueryIoDevicequery_io_deviceQueryIoDeviceQueryIoDevice — Query information about channels of the specified I/O device.

Signature

query_io_device( : : IODeviceHandle, IOChannelName, Query : Result)

Herror T_query_io_device(const Htuple IODeviceHandle, const Htuple IOChannelName, const Htuple Query, Htuple* Result)

Herror query_io_device(const HTuple& IODeviceHandle, const HTuple& IOChannelName, const HTuple& Query, HTuple* Result)

HTuple HIODevice::QueryIoDevice(const HTuple& IOChannelName, const HTuple& Query) const

void QueryIoDevice(const HTuple& IODeviceHandle, const HTuple& IOChannelName, const HTuple& Query, HTuple* Result)

HTuple HIODevice::QueryIoDevice(const HTuple& IOChannelName, const HTuple& Query) const

HTuple HIODevice::QueryIoDevice(const HString& IOChannelName, const HTuple& Query) const

HTuple HIODevice::QueryIoDevice(const char* IOChannelName, const HTuple& Query) const

void HOperatorSetX.QueryIoDevice(
[in] VARIANT IODeviceHandle, [in] VARIANT IOChannelName, [in] VARIANT Query, [out] VARIANT* Result)

VARIANT HIODeviceX.QueryIoDevice(
[in] VARIANT IOChannelName, [in] VARIANT Query)

static void HOperatorSet.QueryIoDevice(HTuple IODeviceHandle, HTuple IOChannelName, HTuple query, out HTuple result)

HTuple HIODevice.QueryIoDevice(HTuple IOChannelName, HTuple query)

HTuple HIODevice.QueryIoDevice(string IOChannelName, HTuple query)

Description

The operator query_io_devicequery_io_deviceQueryIoDevicequery_io_deviceQueryIoDeviceQueryIoDevice returns information about transmission channels of a specified I/O device. The handle to the I/O device is passed to in IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle, whereas the channels are addressed by IOChannelNameIOChannelNameIOChannelNameIOChannelNameIOChannelNameIOChannelName. The desired information about the I/O channels is specified via QueryQueryQueryQueryQueryquery. A list of all supported channel names is usually returned when passing 'io_channel_name'"io_channel_name""io_channel_name""io_channel_name""io_channel_name""io_channel_name" to QueryQueryQueryQueryQueryquery while the input parameter IOChannelNameIOChannelNameIOChannelNameIOChannelNameIOChannelNameIOChannelName is ignored.

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 channel-specific parameters are listed.

Parallelization

Parameters

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle (input_control)  io_device HIODevice, HTupleHTupleHIODevice, HTupleHIODeviceX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the opened I/O device.

IOChannelNameIOChannelNameIOChannelNameIOChannelNameIOChannelNameIOChannelName (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Channel names to query.

QueryQueryQueryQueryQueryquery (input_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the query.

Default value: 'param_name' "param_name" "param_name" "param_name" "param_name" "param_name"

List of values: 'io_channel_names'"io_channel_names""io_channel_names""io_channel_names""io_channel_names""io_channel_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 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_devicequery_io_deviceQueryIoDevicequery_io_deviceQueryIoDeviceQueryIoDevice 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