tcl/doc/fblocked.n

   1 '\"
   2 '\" Copyright (c) 1996 Sun Microsystems, Inc.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 '\" RCS: @(#) $Id$
   8 .so man.macros
   9 .TH fblocked n 7.5 Tcl "Tcl Built-In Commands"
  10 .BS
  11 '\" Note:  do not modify the .SH NAME line immediately below!
  12 .SH NAME
  13 fblocked \- Test whether the last input operation exhausted all available input
  14 .SH SYNOPSIS
  15 \fBfblocked \fIchannelId\fR
  16 .BE
  17
  18 .SH DESCRIPTION
  19 .PP
  20 The \fBfblocked\fR command returns 1 if the most recent input operation
  21 on \fIchannelId\fR returned less information than requested because all
  22 available input was exhausted.
  23 For example, if \fBgets\fR is invoked when there are only three
  24 characters available for input and no end-of-line sequence, \fBgets\fR
  25 returns an empty string and a subsequent call to \fBfblocked\fR will
  26 return 1.
  27 .PP
  28 .SH "SEE ALSO"
  29 gets(n), read(n)
  30
  31 .SH KEYWORDS
  32 blocking, nonblocking