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

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH ISASTREAM 3C "Jul 24, 2002"
   7 .SH NAME
   8 isastream \- test a file descriptor
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <stropts.h>
  13
  14 \fBint\fR \fBisastream\fR(\fBint\fR \fIfildes\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The  \fBisastream()\fR function determines if a file descriptor represents a
  21 STREAMS file. The \fIfildes\fR argument refers to an open file descriptor.
  22 .SH RETURN VALUES
  23 .sp
  24 .LP
  25 Upon successful completion, \fBisastream()\fR returns \fB1\fR if \fIfildes\fR
  26 represents a STREAMS file, and \fB0\fR if it does not.  Otherwise, \fB\(mi1\fR
  27 is return and \fBerrno\fR is set to indicate the error.
  28 .SH ERRORS
  29 .sp
  30 .LP
  31 The \fBisastream()\fR function will fail if:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fBEBADF\fR\fR
  36 .ad
  37 .RS 9n
  38 The \fIfildes\fR argument is not a valid file descriptor.
  39 .RE
  40
  41 .SH ATTRIBUTES
  42 .sp
  43 .LP
  44 See \fBattributes\fR(5) for descriptions of the following attributes:
  45 .sp
  46
  47 .sp
  48 .TS
  49 box;
  50 c | c
  51 l | l .
  52 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  53 _
  54 Interface Stability     Standard
  55 _
  56 MT-Level        MT-Safe
  57 .TE
  58
  59 .SH SEE ALSO
  60 .sp
  61 .LP
  62 \fBattributes\fR(5), , \fBstandards\fR(5), \fBstreamio\fR(7I)
  63 .sp
  64 .LP
  65 \fISTREAMS Programming Guide\fR