Herror ::get_serial_param (
const HTuple &SerialHandle,
long *BaudRate,
long *DataBits,
char *FlowControl,
char *Parity,
long *StopBits,
long *TotalTimeOut,
long *InterCharTimeOut
)
Get the parameters of a serial device.
::get_serial_param returns the current parameter settings of
the serial device passed in SerialHandle. For a
description of the parameters of a serial device, see
::set_serial_param.
Parameters
SerialHandle (input_control)
|
serial_id -> HTuple.long
|
|
Serial interface handle. |
BaudRate (output_control)
|
integer -> long *
|
|
Speed of the serial interface. |
DataBits (output_control)
|
integer -> long *
|
|
Number of data bits of the serial interface. |
FlowControl (output_control)
|
string -> char *
|
|
Type of flow control of the serial interface. |
Parity (output_control)
|
string -> char *
|
|
Parity of the serial interface. |
StopBits (output_control)
|
integer -> long *
|
|
Number of stop bits of the serial interface. |
TotalTimeOut (output_control)
|
integer -> long *
|
|
Total timeout of the serial interface in ms. |
InterCharTimeOut (output_control)
|
integer -> long *
|
|
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_param returns the value
H_MSG_TRUE. Otherwise an exception is raised.
Possible Predecessors
::open_serial
Possible Successors
::get_serial_param,
::read_serial,
::write_serial
See also
::set_serial_param
Module
System
Copyright © 1996-2002 MVTec Software GmbH