xref: /netbsd/share/man/man3/__arraycount.3 (revision 6550d01e)
1.\" $NetBSD: __arraycount.3,v 1.6 2010/12/16 10:40:04 jruoho Exp $
2.\"
3.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jukka Ruohonen.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd December 16, 2010
31.Dt __ARRAYCOUNT 3
32.Os
33.Sh NAME
34.Nm __arraycount
35.Nd macro for statically allocated arrays
36.Sh SYNOPSIS
37.In sys/cdefs.h
38.Ft size_t
39.Fn __arraycount x
40.Sh DESCRIPTION
41The
42.Fn __arraycount
43macro returns the number of elements in a statically allocated buffer.
44.Sh EXAMPLES
45The following example demonstrates a typical usage of
46.Fn __arraycount :
47.Bd -literal -offset indent
48uint8_t buf[BUFSIZE];
49size_t i;
50
51\&...
52
53for (i = 0; i \*[Lt] __arraycount(buf); i++)
54	\&...
55.Ed
56.Sh SEE ALSO
57.Xr cdefs 3
58.Sh HISTORY
59The
60.Fn __arraycount
61macro first appeared in
62.Nx 4.0 .
63