share/man/man9/device_get_children.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/device_get_children.9,v 1.1.2.3 2001/12/17 11:30:18 ru Exp $
  28 .\" $DragonFly: src/share/man/man9/device_get_children.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd December 1, 1999
  31 .Dt DEVICE_GET_CHILDREN 9
  32 .Os
  33 .Sh NAME
  34 .Nm device_get_children
  35 .Nd get a list of devices connected to a device
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/bus.h
  39 .Ft int
  40 .Fn device_get_children "device_t dev" "device_t **devlistp" "int *devcountp"
  41 .Sh DESCRIPTION
  42 Retrieve a list of all device instances currently connected to
  43 .Pa dev
  44 and return the list in
  45 .Fa *devlistp
  46 and the count in
  47 .Fa *devcountp .
  48 The memory allocated for the list should be freed using
  49 .Fn free "*devlistp" "M_TEMP" .
  50 .Sh RETURN VALUES
  51 Zero is returned on success, otherwise an appropriate error is returned.
  52 .Sh SEE ALSO
  53 .Xr devclass 9 ,
  54 .Xr device 9
  55 .Sh AUTHORS
  56 This man page was written by
  57 .An Doug Rabson .