HALCON Reference Manual 10.0.2
Table of Contents / System / Serial ClassesClassesClasses | | | Operators

get_serial_paramget_serial_paramget_serial_paramGetSerialParamGetSerialParam (Operator)

Name

get_serial_paramget_serial_paramget_serial_paramGetSerialParamGetSerialParam — Get the parameters of a serial device.

Signature

get_serial_param( : : SerialHandle : BaudRate, DataBits, FlowControl, Parity, StopBits, TotalTimeOut, InterCharTimeOut)

Herror get_serial_param(const Hlong SerialHandle, Hlong* BaudRate, Hlong* DataBits, char* FlowControl, char* Parity, Hlong* StopBits, Hlong* TotalTimeOut, Hlong* InterCharTimeOut)

Herror T_get_serial_param(const Htuple SerialHandle, Htuple* BaudRate, Htuple* DataBits, Htuple* FlowControl, Htuple* Parity, Htuple* StopBits, Htuple* TotalTimeOut, Htuple* InterCharTimeOut)

Herror get_serial_param(const HTuple& SerialHandle, Hlong* BaudRate, Hlong* DataBits, char* FlowControl, char* Parity, Hlong* StopBits, Hlong* TotalTimeOut, Hlong* InterCharTimeOut)

Hlong HSerial::GetSerialParam(HTuple* DataBits, HTuple* FlowControl, HTuple* Parity, HTuple* StopBits, HTuple* TotalTimeOut, HTuple* InterCharTimeOut) const

void HOperatorSetX.GetSerialParam(
[in] VARIANT SerialHandle, [out] VARIANT* BaudRate, [out] VARIANT* DataBits, [out] VARIANT* FlowControl, [out] VARIANT* Parity, [out] VARIANT* StopBits, [out] VARIANT* TotalTimeOut, [out] VARIANT* InterCharTimeOut)

Hlong HSerialX.GetSerialParam(
[out] Hlong* DataBits, [out] BSTR* FlowControl, [out] BSTR* Parity, [out] Hlong* StopBits, [out] Hlong* TotalTimeOut, [out] Hlong* InterCharTimeOut)

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_paramget_serial_paramGetSerialParamGetSerialParam 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_paramset_serial_paramSetSerialParamSetSerialParam.

Parallelization

Parameters

SerialHandleSerialHandleSerialHandleSerialHandleserialHandle (input_control)  serial_id → HSerial, HTupleHSerial, HTupleHSerialX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong)

Serial interface handle.

BaudRateBaudRateBaudRateBaudRatebaudRate (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Speed of the serial interface.

DataBitsDataBitsDataBitsDataBitsdataBits (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Number of data bits of the serial interface.

FlowControlFlowControlFlowControlFlowControlflowControl (output_control)  string → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Type of flow control of the serial interface.

ParityParityParityParityparity (output_control)  string → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Parity of the serial interface.

StopBitsStopBitsStopBitsStopBitsstopBits (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Number of stop bits of the serial interface.

TotalTimeOutTotalTimeOutTotalTimeOutTotalTimeOuttotalTimeOut (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Total timeout of the serial interface in ms.

InterCharTimeOutInterCharTimeOutInterCharTimeOutInterCharTimeOutinterCharTimeOut (output_control)  integer → HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (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_paramget_serial_paramGetSerialParamGetSerialParam returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

open_serialopen_serialopen_serialOpenSerialOpenSerial

Possible Successors

get_serial_paramget_serial_paramget_serial_paramGetSerialParamGetSerialParam, read_serialread_serialread_serialReadSerialReadSerial, write_serialwrite_serialwrite_serialWriteSerialWriteSerial

See also

set_serial_paramset_serial_paramset_serial_paramSetSerialParamSetSerialParam

Module

Foundation

Table of Contents / System / Serial ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH