share/man/man9/device_delete_children.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2018 Jeroen Ruigrok van der Werven
   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$
  30 .\"
  31 .Dd September 28, 2018
  32 .Dt DEVICE_DELETE_CHILDREN 9
  33 .Os
  34 .Sh NAME
  35 .Nm device_delete_children
  36 .Nd delete all child devices of a given device
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/bus.h
  40 .Ft int
  41 .Fn device_delete_children "device_t dev"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn device_delete_children
  45 function deletes all child devices of the given device
  46 .Fa dev ,
  47 if any,
  48 using the
  49 .Fn device_delete_child
  50 function for each device it finds.
  51 If a child device cannot be deleted, this function will return an error code.
  52 .Sh RETURN VALUES
  53 Zero is returned on success, a non-zero return value indicates failure.
  54 .Sh SEE ALSO
  55 .Xr device_delete_child 9
  56 .Sh AUTHORS
  57 This manual page was written by
  58 .An Jeroen Ruigrok van der Werven .