Merge commit '9276b3991ba20d5a5660887ba81b0bc7bed25a0c'
[unleashed.git] / share / man / man9f / net_protocol_release.9f
blobf1759d099df44741c81cd17696ef1b633577506e
1 '\" te
2 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved.
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH NET_PROTOCOL_RELEASE 9F "Mar 5, 2012"
8 .SH NAME
9 net_protocol_release \- indicate that a reference to a network protocol is no
10 longer required
11 .SH SYNOPSIS
12 .LP
13 .nf
14 #include <sys/neti.h>
16 \fBint\fR \fBnet_protocol_release\fR(\fBnet_handle_t\fR \fIinfo\fR);
17 .fi
19 .SH INTERFACE LEVEL
20 .sp
21 .LP
22 Solaris DDI specific (Solaris DDI).
23 .SH PARAMETERS
24 .sp
25 .ne 2
26 .na
27 \fB\fIinfo\fR\fR
28 .ad
29 .RS 7n
30 value returned from a successful call to \fBnet_protocol_lookup\fR(9F).
31 .RE
33 .SH DESCRIPTION
34 .sp
35 .LP
36 The \fBnet_protocol_release()\fR function indicates to the network information
37 framework that the caller is no longer interested in any knowledge about the
38 network protocol to which the parameter being passed through applies.
39 .SH RETURN VALUES
40 .sp
41 .LP
42 The \fBnet_protocol_release()\fR function returns:
43 .sp
44 .ne 2
45 .na
46 \fB-1\fR
47 .ad
48 .RS 6n
49 The value passed in is unknown to this framework.
50 .RE
52 .sp
53 .ne 2
54 .na
55 \fB0\fR
56 .ad
57 .RS 6n
58 Successful completion.
59 .RE
61 .sp
62 .ne 2
63 .na
64 \fB1\fR
65 .ad
66 .RS 6n
67 Unsuccessful because this function has been called too many times.
68 .RE
70 .SH CONTEXT
71 .sp
72 .LP
73 The \fBnet_protocol_release()\fR function may be called from user,  kernel, or
74 interrupt context.
75 .SH ATTRIBUTES
76 .sp
77 .LP
78 See \fBattributes\fR(5) for descriptions of the following attributes:
79 .sp
81 .sp
82 .TS
83 box;
84 c | c
85 l | l .
86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
88 Interface Stability     Committed
89 .TE
91 .SH SEE ALSO
92 .sp
93 .LP
94 \fBnet_protocol_lookup\fR(9F), \fBnet_protocol_walk\fR(9F), \fBattributes\fR(5)