share/man/man9/devclass_get_devices.9

   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 .\" $FreeBSD: src/share/man/man9/devclass_get_devices.9,v 1.4.2.3 2001/12/17 11:30:18 ru Exp $
  30 .\" $DragonFly: src/share/man/man9/devclass_get_devices.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
  31 .\"
  32 .Dd June 16, 1998
  33 .Dt DEVCLASS_GET_DEVICES 9
  34 .Os
  35 .Sh NAME
  36 .Nm devclass_get_devices
  37 .Nd get a list of devices in a devclass
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/bus.h
  41 .Ft int
  42 .Fn devclass_get_devices "devclass_t dc" "device_t **devlistp" "int *devcountp"
  43 .Sh DESCRIPTION
  44 Retrieve a list of all device instances currently in the devclass and
  45 return the list in
  46 .Fa *devlistp
  47 and the count in
  48 .Fa *devcountp .
  49 The memory allocated for the list should be freed using
  50 .Fn free "*devlistp" "M_TEMP" .
  51 .Sh RETURN VALUES
  52 Zero 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
  57 This man page was written by
  58 .An Doug Rabson .