summaryrefslogtreecommitdiffstats
path: root/man3p/cfsetispeed.3p
blob: 24f974657fc793e2a9622a8f951783f847eddff3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved 
.TH "CFSETISPEED" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\" cfsetispeed 
.SH NAME
cfsetispeed \- set input baud rate
.SH SYNOPSIS
.LP
\fB#include <termios.h>
.br
.sp
int cfsetispeed(struct termios *\fP\fItermios_p\fP\fB, speed_t\fP
\fIspeed\fP\fB);
.br
\fP
.SH DESCRIPTION
.LP
The \fIcfsetispeed\fP() function shall set the input baud rate stored
in the structure pointed to by \fItermios_p\fP to
\fIspeed.\fP
.LP
There shall be no effect on the baud rates set in the hardware until
a subsequent successful call to \fItcsetattr\fP() with the same \fBtermios\fP
structure. Similarly, errors resulting from
attempts to set baud rates not supported by the terminal device need
not be detected until the \fItcsetattr\fP() function is called.
.SH RETURN VALUE
.LP
Upon successful completion, \fIcfsetispeed\fP() shall return 0; otherwise,
-1 shall be returned, and \fIerrno\fP may be set to
indicate the error.
.SH ERRORS
.LP
The \fIcfsetispeed\fP() function may fail if:
.TP 7
.B EINVAL
The \fIspeed\fP value is not a valid baud rate.
.TP 7
.B EINVAL
The value of \fIspeed\fP is outside the range of possible speed values
as specified in \fI<termios.h>\fP.
.sp
.LP
\fIThe following sections are informative.\fP
.SH EXAMPLES
.LP
None.
.SH APPLICATION USAGE
.LP
None.
.SH RATIONALE
.LP
Refer to \fIcfgetispeed\fP() .
.SH FUTURE DIRECTIONS
.LP
None.
.SH SEE ALSO
.LP
\fIcfgetispeed\fP() , \fIcfgetospeed\fP() , \fIcfsetospeed\fP() ,
\fItcsetattr\fP() , the Base Definitions volume of
IEEE\ Std\ 1003.1-2001, Chapter 11, General Terminal Interface, \fI<termios.h>\fP
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group. In the
event of any discrepancy between this version 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 .