share/man/man9/devclass_get_devices.9

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