src/lib/libpthread/man/getc_unlocked.3

48 lines
1002 B
Groff

.\" $OpenBSD: getc_unlocked.3,v 1.6 2015/09/14 13:45:25 schwarze Exp $
.\" David Leonard <d@openbsd.org>, 1999. Public domain.
.Dd $Mdocdate: September 14 2015 $
.Dt GETC_UNLOCKED 3
.Os
.Sh NAME
.Nm getc_unlocked ,
.Nm getchar_unlocked
.Nd get next character from stream, efficiently
.Sh SYNOPSIS
.In stdio.h
.Ft int
.Fn getc_unlocked "FILE *stream"
.Ft int
.Fn getchar_unlocked void
.Sh DESCRIPTION
The
.Fn getc_unlocked
and
.Fn getchar_unlocked
functions are equivalent to their locked counterparts,
.Xr getc 3
and
.Xr getchar 3 .
However,
.Fn getc_unlocked
and
.Fn getchar_unlocked
assume that the relevant stream has either been previously locked
with
.Xr flockfile 3 ,
or that it will not be accessed by any other thread.
.Sh RETURN VALUES
The return values are as described for
.Xr getc 3
and
.Xr getchar 3 .
.Sh SEE ALSO
.Xr getc 3 ,
.Xr getchar 3
.Sh STANDARDS
.Fn getc_unlocked
and
.Fn getchar_unlocked
conform to ISO/IEC 9945-1 ANSI/IEEE
.Pq Dq Tn POSIX
Std 1003.1 Second Edition 1996-07-12.