share/man/man9f/mcopymsg.9f

   1 '\" te
   2 .\" Copyright (c) 2007, 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 MCOPYMSG 9F "Oct 16, 2007"
   7 .SH NAME
   8 mcopymsg \- Copy message contents into a buffer and free message
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/stream.h>
  13 #include <sys/strsun.h>
  14
  15
  16
  17 \fBvoid\fR \fBmcopymsg\fR(\fBmblk_t *\fR\fImp\fR, \fBvoid *\fR\fIbuf\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fImp\fR\fR
  29 .ad
  30 .RS 7n
  31 Message to be copied.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIbuf\fR\fR
  38 .ad
  39 .RS 7n
  40 Buffer in which to copy.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBmcopymsg()\fR function copies the contents of the specified message into
  47 the specified buffer. If the message consists of more than a single message
  48 block, the contents of each message block are placed consecutively into the
  49 buffer. After copying the message contents to \fIbuf\fR, \fBmcopymsg()\fR frees
  50 the message \fImp\fR.
  51 .sp
  52 .LP
  53 The provided buffer must be large enough to accommodate the message. If the
  54 buffer is not large enough, the results are unspecified. The \fBmsgsize\fR(9F)
  55 function can be used to calculate the total size of the message beforehand.
  56 .SH RETURN VALUES
  57 .sp
  58 .LP
  59 None.
  60 .SH CONTEXT
  61 .sp
  62 .LP
  63 This function can be called from user, kernel or interrupt context.
  64 .SH SEE ALSO
  65 .sp
  66 .LP
  67 \fBfreemsg\fR(9F), \fBmsgsize\fR(9F)
  68 .sp
  69 .LP
  70 \fISTREAMS Programming Guide\fR