get_serial_paramT_get_serial_paramGetSerialParamGetSerialParam (Operator)
Name
get_serial_paramT_get_serial_paramGetSerialParamGetSerialParam — Get the parameters of a serial device.
Signature
void GetSerialParam(const HTuple& SerialHandle, HTuple* BaudRate, HTuple* DataBits, HTuple* FlowControl, HTuple* Parity, HTuple* StopBits, HTuple* TotalTimeOut, HTuple* InterCharTimeOut)
Hlong HSerial::GetSerialParam(Hlong* DataBits, HString* FlowControl, HString* Parity, Hlong* StopBits, Hlong* TotalTimeOut, Hlong* InterCharTimeOut) const
static void HOperatorSet.GetSerialParam(HTuple serialHandle, out HTuple baudRate, out HTuple dataBits, out HTuple flowControl, out HTuple parity, out HTuple stopBits, out HTuple totalTimeOut, out HTuple interCharTimeOut)
int HSerial.GetSerialParam(out int dataBits, out string flowControl, out string parity, out int stopBits, out int totalTimeOut, out int interCharTimeOut)
Description
get_serial_paramget_serial_paramGetSerialParamGetSerialParamGetSerialParam returns the current parameter settings of
the serial device passed in SerialHandleSerialHandleSerialHandleSerialHandleserialHandle. For a
description of the parameters of a serial device, see
set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParam.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator modifies the state of the following input parameter:
The value of this parameter may not be shared across multiple threads without external synchronization.
Parameters
SerialHandleSerialHandleSerialHandleSerialHandleserialHandle (input_control, state is modified) serial → HSerial, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Serial interface handle.
BaudRateBaudRateBaudRateBaudRatebaudRate (output_control) integer → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Speed of the serial interface.
DataBitsDataBitsDataBitsDataBitsdataBits (output_control) integer → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of data bits of the serial interface.
FlowControlFlowControlFlowControlFlowControlflowControl (output_control) string → HTupleHTupleHtuple (string) (string) (HString) (char*)
Type of flow control of the serial interface.
ParityParityParityParityparity (output_control) string → HTupleHTupleHtuple (string) (string) (HString) (char*)
Parity of the serial interface.
StopBitsStopBitsStopBitsStopBitsstopBits (output_control) integer → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of stop bits of the serial interface.
TotalTimeOutTotalTimeOutTotalTimeOutTotalTimeOuttotalTimeOut (output_control) integer → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Total timeout of the serial interface in ms.
InterCharTimeOutInterCharTimeOutInterCharTimeOutInterCharTimeOutinterCharTimeOut (output_control) integer → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Inter-character timeout of the serial interface
in ms.
Result
If the parameters are correct and the parameters of the device could
be read, the operator get_serial_paramget_serial_paramGetSerialParamGetSerialParamGetSerialParam returns the value
2 (H_MSG_TRUE). Otherwise an exception is raised.
Possible Predecessors
open_serialopen_serialOpenSerialOpenSerialOpenSerial
Possible Successors
read_serialread_serialReadSerialReadSerialReadSerial,
write_serialwrite_serialWriteSerialWriteSerialWriteSerial
See also
set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParam
Module
Foundation