share/man/man9f/freemsg.9f

   1 '\" te
   2 .\" Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   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 FREEMSG 9F "Jan 16, 2006"
   8 .SH NAME
   9 freemsg \- free all message blocks in a message
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBvoid\fR \fBfreemsg\fR(\fBmblk_t *\fR\fImp\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Architecture independent level 1 (DDI/DKI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fImp\fR\fR
  29 .ad
  30 .RS 6n
  31 Pointer to the message blocks to be deallocated. \fBmblk_t\fR is an instance of
  32 the \fBmsgb\fR(9S) structure. If \fImp\fR is \fINULL\fR, \fBfreemsg()\fR
  33 immediately returns.
  34 .RE
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 The \fBfreemsg()\fR function calls \fBfreeb\fR(9F) to free all message and data
  40 blocks associated with the message pointed to by \fImp\fR.
  41 .SH CONTEXT
  42 .sp
  43 .LP
  44 The \fBfreemsg()\fR function can be called from user, interrupt, or kernel
  45 context.
  46 .SH EXAMPLES
  47 .LP
  48 \fBExample 1 \fRUsing \fBfreemsg()\fR
  49 .sp
  50 .LP
  51 See \fBcopymsg\fR(9F).
  52
  53 .SH SEE ALSO
  54 .sp
  55 .LP
  56 \fBcopymsg\fR(9F), \fBfreeb\fR(9F), \fBmsgb\fR(9S)
  57 .sp
  58 .LP
  59 \fIWriting Device Drivers\fR
  60 .sp
  61 .LP
  62 \fISTREAMS Programming Guide\fR
  63 .SH NOTES
  64 .sp
  65 .LP
  66 The behavior of \fBfreemsg()\fR when passed a \fINULL\fR pointer is
  67 Solaris-specific.