xref: /freebsd/share/man/man9/device_delete_children.9 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1*fc6eed42SWarner Losh.\" -*- nroff -*-
2*fc6eed42SWarner Losh.\"
3*fc6eed42SWarner Losh.\" Copyright (c) 2018 Jeroen Ruigrok van der Werven
4*fc6eed42SWarner Losh.\"
5*fc6eed42SWarner Losh.\" All rights reserved.
6*fc6eed42SWarner Losh.\"
7*fc6eed42SWarner Losh.\" This program is free software.
8*fc6eed42SWarner Losh.\"
9*fc6eed42SWarner Losh.\" Redistribution and use in source and binary forms, with or without
10*fc6eed42SWarner Losh.\" modification, are permitted provided that the following conditions
11*fc6eed42SWarner Losh.\" are met:
12*fc6eed42SWarner Losh.\" 1. Redistributions of source code must retain the above copyright
13*fc6eed42SWarner Losh.\"    notice, this list of conditions and the following disclaimer.
14*fc6eed42SWarner Losh.\" 2. Redistributions in binary form must reproduce the above copyright
15*fc6eed42SWarner Losh.\"    notice, this list of conditions and the following disclaimer in the
16*fc6eed42SWarner Losh.\"    documentation and/or other materials provided with the distribution.
17*fc6eed42SWarner Losh.\"
18*fc6eed42SWarner Losh.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19*fc6eed42SWarner Losh.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20*fc6eed42SWarner Losh.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21*fc6eed42SWarner Losh.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22*fc6eed42SWarner Losh.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23*fc6eed42SWarner Losh.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*fc6eed42SWarner Losh.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*fc6eed42SWarner Losh.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*fc6eed42SWarner Losh.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27*fc6eed42SWarner Losh.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*fc6eed42SWarner Losh.\"
29*fc6eed42SWarner Losh.Dd September 28, 2018
30*fc6eed42SWarner Losh.Dt DEVICE_DELETE_CHILDREN 9
31*fc6eed42SWarner Losh.Os
32*fc6eed42SWarner Losh.Sh NAME
33*fc6eed42SWarner Losh.Nm device_delete_children
34*fc6eed42SWarner Losh.Nd delete all child devices of a given device
35*fc6eed42SWarner Losh.Sh SYNOPSIS
36*fc6eed42SWarner Losh.In sys/param.h
37*fc6eed42SWarner Losh.In sys/bus.h
38*fc6eed42SWarner Losh.Ft int
39*fc6eed42SWarner Losh.Fn device_delete_children "device_t dev"
40*fc6eed42SWarner Losh.Sh DESCRIPTION
41*fc6eed42SWarner LoshThe
42*fc6eed42SWarner Losh.Fn device_delete_children
43*fc6eed42SWarner Loshfunction deletes all child devices of the given device
44*fc6eed42SWarner Losh.Fa dev ,
45*fc6eed42SWarner Loshif any,
46*fc6eed42SWarner Loshusing the
47*fc6eed42SWarner Losh.Fn device_delete_child
48*fc6eed42SWarner Loshfunction for each device it finds.
49*fc6eed42SWarner LoshIf a child device cannot be deleted, this function will return an error code.
50*fc6eed42SWarner Losh.Sh RETURN VALUES
51*fc6eed42SWarner LoshZero is returned on success, a non-zero return value indicates failure.
52*fc6eed42SWarner Losh.Sh SEE ALSO
53*fc6eed42SWarner Losh.Xr device_delete_child 9
54*fc6eed42SWarner Losh.Sh AUTHORS
55*fc6eed42SWarner LoshThis manual page was written by
56*fc6eed42SWarner Losh.An Jeroen Ruigrok van der Werven .
57