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

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