Merge commit '9276b3991ba20d5a5660887ba81b0bc7bed25a0c'
[unleashed.git] / share / man / man9f / net_instance_unregister.9f
blob9fa3a44b46c8e747d10eedcdffc160bb7ee088b5
1 '\" te
2 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH NET_INSTANCE_UNREGISTER 9F "May 1, 2008"
7 .SH NAME
8 net_instance_unregister \- disable a set of instances
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/neti.h>
14 \fBvoid\fR \fBnet_instance_unregister\fR(\fBnet_instance_t\fR *\fBinstances\fR);
15 .fi
17 .SH INTERFACE LEVEL
18 .sp
19 .LP
20 Solaris DDI specific (Solaris DDI).
21 .SH PARAMETERS
22 .sp
23 .ne 2
24 .na
25 \fB\fIinstances\fR\fR
26 .ad
27 .RS 13n
28 must be a pointer returned by \fBnet_instance_alloc\fR(9F).
29 .RE
31 .SH DESCRIPTION
32 .sp
33 .LP
34 The \fBnet_instance_unregister()\fR function removes the set of instances that
35 were previously registered with the \fBnet_instance_register()\fR function.
36 .SH RETURN VALUES
37 .sp
38 .LP
39 If the \fBnet_instance_unregister()\fR function succeeds, 0 is returned.
40 Otherwise, an error indicating the problem encountered.
41 .SH CONTEXT
42 .sp
43 .LP
44 The \fBnet_instance_unregister()\fR function may be called from user,  kernel,
45 or interrupt context.
46 .SH ATTRIBUTES
47 .sp
48 .LP
49 See \fBattributes\fR(5) for descriptions of the following attributes:
50 .sp
52 .sp
53 .TS
54 box;
55 c | c
56 l | l .
57 ATTRIBUTE TYPE  ATTRIBUTE VALUE
59 Interface Stability     Committed
60 .TE
62 .SH SEE ALSO
63 .sp
64 .LP
65 \fBnet_instance_alloc\fR(9F), \fBnet_instance_register\fR(9F),
66 \fBattributes\fR(5), \fBnet_instance_t\fR(9S)