libserialport  unreleased development snapshot
cross-platform library for accessing serial ports
 All Data Structures Files Functions Variables Enumerations Enumerator Modules Pages
Functions
Signals

Port signalling operations. More...

Functions

enum sp_return sp_get_signals (struct sp_port *port, enum sp_signal *signal_mask)
 Gets the status of the control signals for the specified port. More...
 
enum sp_return sp_start_break (struct sp_port *port)
 Put the port transmit line into the break state. More...
 
enum sp_return sp_end_break (struct sp_port *port)
 Take the port transmit line out of the break state. More...
 

Detailed Description

Port signalling operations.

Function Documentation

enum sp_return sp_end_break ( struct sp_port port)

Take the port transmit line out of the break state.

Parameters
[in]portPointer to a port structure. Must not be NULL.
Returns
SP_OK upon success, a negative error code otherwise.
Since
0.1.0
enum sp_return sp_get_signals ( struct sp_port port,
enum sp_signal signal_mask 
)

Gets the status of the control signals for the specified port.

The user should allocate a variable of type "enum sp_signal" and pass a pointer to this variable to receive the result. The result is a bitmask in which individual signals can be checked by bitwise OR with values of the sp_signal enum.

Parameters
[in]portPointer to a port structure. Must not be NULL.
[out]signal_maskPointer to a variable to receive the result. Must not be NULL.
Returns
SP_OK upon success, a negative error code otherwise.
Since
0.1.0
enum sp_return sp_start_break ( struct sp_port port)

Put the port transmit line into the break state.

Parameters
[in]portPointer to a port structure. Must not be NULL.
Returns
SP_OK upon success, a negative error code otherwise.
Since
0.1.0