share/man/man9f/clrbuf.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 CLRBUF 9F "Jan 16, 2006"
   8 .SH NAME
   9 clrbuf \- erase the contents of a buffer
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/types.h>
  14 #include <sys/buf.h>
  15
  16
  17
  18 \fBvoid\fR \fBclrbuf\fR(\fBstruct buf *\fR\fIbp\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\fIbp\fR\fR
  30 .ad
  31 .RS 6n
  32 Pointer to the \fBbuf\fR(9S) structure.
  33 .RE
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 The \fBclrbuf()\fR function zeros a buffer and sets the \fBb_resid\fR member of
  39 the \fBbuf\fR(9S) structure to \fB0\fR. Zeros are placed in the buffer starting
  40 at \fIbp\fR\fB\(->b_un.b_addr\fR for a length of \fIbp\fR\fB\(->b_bcount\fR
  41 bytes. \fBb_un.b_addr\fR and \fBb_bcount\fR are members of the \fBbuf\fR(9S)
  42 data structure.
  43 .SH CONTEXT
  44 .sp
  45 .LP
  46 The \fBclrbuf()\fR function can be called from user, interrupt, or kernel
  47 context.
  48 .SH SEE ALSO
  49 .sp
  50 .LP
  51 \fBgetrbuf\fR(9F), \fBbuf\fR(9S)
  52 .sp
  53 .LP
  54 \fIWriting Device Drivers\fR