LabWindows/CVI

Content Type
Programming Language
Current manual

GetComLineStatus

GetComLineStatus

unsigned int GetComLineStatus (int portNumber);

Purpose

Returns the modem control-register values.

(Linux) This function is not supported.

Parameters

Input
Name Type Description
portNumber int A number that indicates the COM port on which to operate.

This number maps to the COM port specified by deviceName in the call to OpenCom or OpenComConfig. The portNumber 1, for example, may not necessarily map to COM1.

(Linux) The portNumber 1, for example, may not necessarily map to /dev/ttyS0.

Valid Range: 1—1,000

Return Value

Name Type Description
lineStatus unsigned int Hardware-specific information about the status of the selected port.

The status word is comprised of individual bits, each with a different meaning. This parameter is filled in with a combination of the following values:

Name Value Description
kRS_CTS_ON 0x10 The CTS (clear-to-send) signal is on.
kRS_DSR_ON 0x20 The DSR (data-set-ready) signal is on.
kRS_RING_ON 0x40 The ring indicator signal is on.
kRS_RLSD_ON 0x80 The RLSD (receive-line-signal-detect) signal is on.

Additional Information

Library: RS-232 Library

Include file: rs232.h

LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later

Was this information helpful?

Help us improve your future ni.com experience.

Did you find the documentation you were looking for?

Submit