xref: /freebsd/share/man/man9/devclass_get_devices.9 (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1998 Doug Rabson
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
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 DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $Id$
30.\"
31.Dd June 16, 1998
32.Dt devclass_get_devices 9
33.Os FreeBSD
34.Sh NAME
35.Nm devclass_get_devices
36.Nd get a list of devices in a devclass
37.Sh SYNOPSIS
38.Fd #include <sys/param.h>
39.Fd #include <sys/bus.h>
40.Ft int
41.Fn devclass_get_devices "devclass_t dc" "int device_t **devlistp" "int *devcountp"
42.Sh DESCRIPTION
43.Pp
44Retrieve a list of all device instances currently in the devclass and
45return the list in
46.Fa *devlistp
47and the count in
48.Fa *devcountp .
49The memory allocated for the list should be freed using
50.Fn free "*devlistp" "M_TEMP" .
51.Sh RETURN VALUES
52Zero is returned on success, otherwise an appropriate error is returned.
53.Sh SEE ALSO
54.Xr devclass 9 ,
55.Xr device 9
56.Sh AUTHORS
57This man page was written by
58.An Doug Rabson .
59