lib/libc/string/bzero.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)bzero.3     8.1 (Berkeley) 6/4/93
  36 .\" $FreeBSD: src/lib/libc/string/bzero.3,v 1.3.2.4 2001/12/14 18:33:59 ru Exp $
  37 .\" $DragonFly: src/lib/libc/string/bzero.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  38 .\"
  39 .Dd June 4, 1993
  40 .Dt BZERO 3
  41 .Os
  42 .Sh NAME
  43 .Nm bzero
  44 .Nd write zeroes to a byte string
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In string.h
  49 .Ft void
  50 .Fn bzero "void *b" "size_t len"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn bzero
  54 function
  55 writes
  56 .Fa len
  57 zero bytes to the string
  58 .Fa b .
  59 If
  60 .Fa len
  61 is zero,
  62 .Fn bzero
  63 does nothing.
  64 .Sh SEE ALSO
  65 .Xr memset 3 ,
  66 .Xr swab 3
  67 .Sh HISTORY
  68 A
  69 .Fn bzero
  70 function
  71 appeared in
  72 .Bx 4.3 .