share/man/man9f/hook_alloc.9f

   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 HOOK_ALLOC 9F "May 1, 2008"
   7 .SH NAME
   8 hook_alloc \- allocate a hook_t data structure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/hook.h>
  13
  14 \fBhook_t *\fR\fBhook_alloc\fR(\fBconst\fR \fBint\fR \fIversion\fR);
  15 .fi
  16
  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\fIversion\fR\fR
  26 .ad
  27 .RS 11n
  28 must always be the symbol \fBHOOK_VERSION\fR.
  29 .RE
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The \fBhook_alloc()\fR function allocates a \fBhook_t\fR structure, returning a
  35 pointer for the caller to use.
  36 .SH RETURN VALUES
  37 .sp
  38 .LP
  39 Upon success, \fBhook_alloc()\fR returns a pointer to the allocated
  40 \fIhook_t\fR structure. On failure, \fBhook_alloc()\fR returns a \fINULL\fR
  41 pointer.
  42 .SH CONTEXT
  43 .sp
  44 .LP
  45 The \fBhook_alloc()\fR function may be called from user  or kernel context.
  46 .SH ATTRIBUTES
  47 .sp
  48 .LP
  49 See \fBattributes\fR(5) for descriptions of the following attributes:
  50 .sp
  51
  52 .sp
  53 .TS
  54 box;
  55 c | c
  56 l | l .
  57 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  58 _
  59 Interface Stability     Committed
  60 .TE
  61
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBhook_free\fR(9F), \fBhook_t\fR(9S)