[apple/libc.git] / string / FreeBSD / bzero.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)bzero.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/string/bzero.3,v 1.10 2007/01/09 00:28:11 imp Exp $
.\"
.Dd June 4, 1993
.Dt BZERO 3
.Os
.Sh NAME
.Nm bzero
.Nd write zeroes to a byte string
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In strings.h
.Ft void
.Fn bzero "void *s" "size_t n"
.Sh DESCRIPTION
The
.Fn bzero
function
writes
.Fa n
zeroed bytes to the string
.Fa s .
If
.Fa n
is zero,
.Fn bzero
does nothing.
.Sh SEE ALSO
.Xr memset 3 ,
.Xr swab 3
.Sh HISTORY
A
.Fn bzero
function
appeared in
.Bx 4.3 .
Its prototype existed previously in
.In string.h
before it was moved to
.In strings.h
for
.St -p1003.1-2001
compliance.
.Pp
.Fn bzero
was deprecated in
.St -p1003.1-2001
and removed in
.St -p1003.1-2008 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1990, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
5b2abdfb A	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" Chris Torek.
	6	.\"
e9ce8d39 A	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.
e9ce8d39 A	15	.\" 4. Neither the name of the University nor the names of its contributors
	16	.\" may be used to endorse or promote products derived from this software
	17	.\" without specific prior written permission.
	18	.\"
	19	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	20	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	21	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	22	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	23	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	24	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	25	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	26	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	27	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	28	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	29	.\" SUCH DAMAGE.
	30	.\"
5b2abdfb	31	.\" @(#)bzero.3 8.1 (Berkeley) 6/4/93
1f2f436a	32	.\" $FreeBSD: src/lib/libc/string/bzero.3,v 1.10 2007/01/09 00:28:11 imp Exp $
e9ce8d39	33	.\"
5b2abdfb A	34	.Dd June 4, 1993
5b2abdfb A	35	.Dt BZERO 3
e9ce8d39 A	36	.Os
e9ce8d39 A	37	.Sh NAME
5b2abdfb A	38	.Nm bzero
5b2abdfb A	39	.Nd write zeroes to a byte string
e9ce8d39 A	40	.Sh LIBRARY
	41	.Lb libc
	42	.Sh SYNOPSIS
9385eb3d	43	.In strings.h
5b2abdfb	44	.Ft void
ad3c9f2a	45	.Fn bzero "void *s" "size_t n"
e9ce8d39 A	46	.Sh DESCRIPTION
e9ce8d39 A	47	The
5b2abdfb A	48	.Fn bzero
	49	function
	50	writes
ad3c9f2a A	51	.Fa n
	52	zeroed bytes to the string
	53	.Fa s .
5b2abdfb	54	If
ad3c9f2a	55	.Fa n
5b2abdfb A	56	is zero,
	57	.Fn bzero
	58	does nothing.
e9ce8d39	59	.Sh SEE ALSO
5b2abdfb A	60	.Xr memset 3 ,
5b2abdfb A	61	.Xr swab 3
e9ce8d39	62	.Sh HISTORY
5b2abdfb A	63	A
	64	.Fn bzero
	65	function
	66	appeared in
	67	.Bx 4.3 .
9385eb3d	68	Its prototype existed previously in
3d9156a7	69	.In string.h
9385eb3d	70	before it was moved to
3d9156a7	71	.In strings.h
9385eb3d A	72	for
	73	.St -p1003.1-2001
	74	compliance.
6465356a A	75	.Pp
	76	.Fn bzero
	77	was deprecated in
	78	.St -p1003.1-2001
	79	and removed in
	80	.St -p1003.1-2008 .