Index for Section 3

Alphabetical listing for T

Bottom of page

tcsendbreak(3)
NAME
  tcsendbreak - Send a break on an asynchronous serial data line

SYNOPSIS
  #include <termios.h>

  int tcsendbreak(
	   int filedes,
	  int duration );

LIBRARY
  Standard C Library (libc)

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  tcsendbreak():  XPG4, XPG4-UNIX

  Refer to the standards(5) reference page for more information about
  industry standards and associated tags.

PARAMETERS
  filedes
      Specifies an open file descriptor.

  duration
      Specifies the number of milliseconds that zero-valued bits are
      transmitted. If the value of the duration parameter is 0 (zero),
      transmission of zero-valued bits is for 250 milliseconds. If duration
      is not 0, transmission of zero-valued bits is for duration
      milliseconds.

DESCRIPTION
  If the terminal is using asynchronous serial data transmission, the
  tcsendbreak() function causes transmission of a continuous stream of zero-
  valued bits for a specific duration. If the terminal is not using
  asynchronous serial data transmission, the tcsendbreak() function returns
  without taking any action.

  A process group is sent a SIGTTOU signal if the tcsendbreak() function is
  called from one of its member processes. If the calling process is blocking
  or ignoring SIGTTOU signals, the process is allowed to perform the
  operation and no signal is sent.

RETURN VALUES
  Upon successful completion, a value of 0 (zero) is returned. Otherwise, -1
  is returned and errno is set to indicate the error.

ERRORS
  The tcsendbreak() function sets errno to the specified values for the
  following conditions:

  [EBADF]
      The filedes parameter does not specify a valid open file descriptor.

  [ENOTTY]
      The file associated with the filedes parameter is not a terminal.

SEE ALSO
  Functions: tcdrain(3), tcflow(3), tcflush(3)

  Files: termios(4)

  Standards: standards(5)

Index for Section 3

Alphabetical listing for T

Top of page