share/man/man9f/ureadc.9f

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   3 .\"  Copyright (c) 2006, Sun Microsystems, Inc., All Rights Reserved
   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 UREADC 9F "Jan 16, 2006"
   8 .SH NAME
   9 ureadc \- add character to a uio structure
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/uio.h>
  14 #include <sys/types.h>
  15
  16
  17
  18 \fBint\fR \fBureadc\fR(\fBint\fR \fIc\fR, \fBuio_t *\fR\fIuio_p\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Architecture independent level 1 (DDI/DKI).
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIc\fR\fR
  30 .ad
  31 .RS 9n
  32 The character added to the  \fBuio\fR(9S) structure.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIuio_p\fR\fR
  39 .ad
  40 .RS 9n
  41 Pointer to the \fBuio\fR(9S) structure.
  42 .RE
  43
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 The \fBureadc()\fR function transfers the character \fIc\fR into the address
  48 space of the \fBuio\fR(9S) structure pointed to by \fIuio_p\fR, and updates the
  49 \fBuio\fR structure as for \fBuiomove\fR(9F).
  50 .SH RETURN VALUES
  51 .sp
  52 .LP
  53 \fB0\fR is returned on success and  \fBEFAULT\fR on failure.
  54 .SH CONTEXT
  55 .sp
  56 .LP
  57 The \fBureadc()\fR function can be called from user, interrupt, or kernel
  58 context.
  59 .SH SEE ALSO
  60 .sp
  61 .LP
  62 \fBuiomove\fR(9F), \fBuwritec\fR(9F), \fBiovec\fR(9S), \fBuio\fR(9S)
  63 .sp
  64 .LP
  65 \fIWriting Device Drivers\fR