share/man/man9f/uwritec.9f

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc., All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH UWRITEC 9F "Jan 16, 2006"
   8 .SH NAME
   9 uwritec \- remove a character from a uio structure
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/uio.h>
  14
  15
  16
  17 \fBint\fR \fBuwritec\fR(\fBuio_t *\fR\fIuio_p\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Architecture independent level 1 (DDI/DKI)
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIuio_p\fR\fR
  29 .ad
  30 .RS 9n
  31 Pointer to the \fBuio\fR(9S) structure
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBuwritec()\fR function returns a character from the \fBuio\fR structure
  38 pointed to by \fIuio_p\fR and updates the \fBuio\fR structure. See
  39 \fBuiomove\fR(9F).
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 The next character for processing is returned on success, and \fB-1\fR is
  44 returned if \fBuio\fR is empty or if there is an error.
  45 .SH CONTEXT
  46 .sp
  47 .LP
  48 The \fBuwritec()\fR function can be called from user, interrupt, or kernel
  49 context.
  50 .SH SEE ALSO
  51 .sp
  52 .LP
  53 \fBuiomove\fR(9F), \fBureadc\fR(9F), \fBiovec\fR(9S), \fBuio\fR(9S)
  54 .sp
  55 .LP
  56 \fIWriting Device Drivers\fR