share/man/man9f/msgdsize.9f

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   3 .\" Copyright (c) 2006, Sun Microsystems, 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 MSGDSIZE 9F "Jan 16, 2006"
   8 .SH NAME
   9 msgdsize \- return the number of bytes in a message
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBsize_t\fR \fBmsgdsize\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 Message to be evaluated.
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBmsgdsize()\fR function counts the number of bytes in a data message.
  38 Only bytes included in the data blocks of type \fBM_DATA\fR are included in the
  39 count.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 The number of data bytes in a message, expressed as an integer.
  44 .SH CONTEXT
  45 .sp
  46 .LP
  47 The \fBmsgdsize()\fR function can be called from user, interrupt, or kernel
  48 context.
  49 .SH EXAMPLES
  50 .sp
  51 .LP
  52 See \fBbufcall\fR(9F) for an example that uses \fBmsgdsize()\fR.
  53 .SH SEE ALSO
  54 .sp
  55 .LP
  56 \fBbufcall\fR(9F)
  57 .sp
  58 .LP
  59 \fIWriting Device Drivers\fR
  60 .sp
  61 .LP
  62 \fISTREAMS Programming Guide\fR