usr/src/man/man3c/cfsetispeed.3c

   1 '\" te
   2 .\"  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH CFSETISPEED 3C "Jul 24, 2002"
  11 .SH NAME
  12 cfsetispeed, cfsetospeed \- set input and output baud rate
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <termios.h>
  17
  18 \fBint\fR \fBcfsetispeed\fR(\fBstruct termios *\fR\fItermios_p\fR, \fBspeed_t\fR \fIspeed\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBcfsetospeed\fR(\fBstruct termios *\fR\fItermios_p\fR, \fBspeed_t\fR \fIspeed\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBcfsetispeed()\fR function sets the input baud rate stored in the
  30 structure pointed to by \fItermios_p\fR to \fIspeed.\fR
  31 .sp
  32 .LP
  33 The \fBcfsetospeed()\fR function sets the output baud rate stored in the
  34 structure pointed to by \fItermios_p\fR to \fIspeed.\fR
  35 .sp
  36 .LP
  37 There is no effect on the baud rates set in the hardware until a subsequent
  38 successful call to \fBtcsetattr\fR(3C) on the same \fBtermios\fR structure.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 Upon successful completion, \fBcfsetispeed()\fR and \fBcfsetospeed()\fR return
  43 \fB0\fR. Otherwise \fB\(mi1\fR is returned, and \fBerrno\fR may be set to
  44 indicate the error.
  45 .SH ERRORS
  46 .sp
  47 .LP
  48 The \fBcfsetispeed()\fR and \fBcfsetospeed()\fR functions may fail if:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBEINVAL\fR\fR
  53 .ad
  54 .RS 10n
  55 The \fIspeed\fR value is not a valid baud rate.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBEINVAL\fR\fR
  62 .ad
  63 .RS 10n
  64 The value of \fIspeed\fR is outside the range of possible speed values as
  65 specified in \fB<termios.h>\fR\&.
  66 .RE
  67
  68 .SH ATTRIBUTES
  69 .sp
  70 .LP
  71 See \fBattributes\fR(5) for descriptions of the following attributes:
  72 .sp
  73
  74 .sp
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 Interface Stability     Standard
  82 _
  83 MT-Level        MT-Safe, and Async-Signal-Safe
  84 .TE
  85
  86 .SH SEE ALSO
  87 .sp
  88 .LP
  89 \fBcfgetispeed\fR(3C), \fBtcsetattr\fR(3C), \fBattributes\fR(5),
  90 \fBstandards\fR(5), \fBtermio\fR(7I)