share/man/man9f/net_instance_alloc.9f

   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_INSTANCE_ALLOC 9F "Mar 5, 2012"
   8 .SH NAME
   9 net_instance_alloc \- allocate a net_instance_t structure
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/neti.h>
  14
  15 \fBnet_instance_t *\fR\fBnet_instance_alloc\fR(\fBconst\fR \fBint\fR \fIversion\fR);
  16 .fi
  17
  18 .SH INTERFACE LEVEL
  19 .sp
  20 .LP
  21 Solaris DDI specific (Solaris DDI).
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIversion\fR\fR
  27 .ad
  28 .RS 11n
  29 must always be the symbol \fBNETINFO_VERSION\fR.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBnet_instance_alloc()\fR function allocates a \fBnet_instance_t\fR
  36 structure, returning a pointer for the caller to use.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 Upon success, \fBnet_instance_alloc()\fR returns a pointer to the allocated
  41 \fInet_instance_t\fR structure. On failure, it returns a \fINULL\fR pointer.
  42 .SH CONTEXT
  43 .sp
  44 .LP
  45 The \fBnet_instance_alloc()\fR function may be called from user or kernel
  46 context.
  47 .SH ATTRIBUTES
  48 .sp
  49 .LP
  50 See \fBattributes\fR(5) for descriptions of the following attributes:
  51 .sp
  52
  53 .sp
  54 .TS
  55 box;
  56 c | c
  57 l | l .
  58 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  59 _
  60 Interface Stability     Committed
  61 .TE
  62
  63 .SH SEE ALSO
  64 .sp
  65 .LP
  66 \fBnet_instance_free\fR(9F), \fBattributes\fR(5), \fBnet_inject_t\fR(9S)