share/man/man9f/miocpullup.9f

   1 '\" te
   2 .\" Copyright (c) 2004, 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 MIOCPULLUP 9F "Jun 9, 2004"
   7 .SH NAME
   8 miocpullup \- Prepare the payload of an M_IOCTL message for access
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/stream.h>
  13 #include <sys/strsun.h>
  14
  15
  16
  17 \fBint\fR \fBmiocpullup\fR(\fBmblk_t *\fR\fImp\fR, \fBsize_t\fR \fIsize\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 8n
  31 M_IOCTL message.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIsize\fR\fR
  38 .ad
  39 .RS 8n
  40 Number of bytes to prepare.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBmiocpullup()\fR function prepares the payload of the specified M_IOCTL
  47 message for access by ensuring that it consists of at least \fIsize\fR bytes of
  48 data.
  49 .sp
  50 .LP
  51 If the M_IOCTL message is transparent, or its total payload is less than
  52 \fIsize\fR bytes, an error is returned.  Otherwise, the payload is concatenated
  53 as necessary to provide contiguous access to at least \fIsize\fR bytes of data.
  54 As a special case, if \fIsize\fR is zero, \fBmiocpullup()\fR returns
  55 successfully, even if no payload exists.
  56 .SH RETURN VALUES
  57 .sp
  58 .LP
  59 Zero is returned on success. Otherwise an errno value is returned indicating
  60 the problem.
  61 .SH CONTEXT
  62 .sp
  63 .LP
  64 This function can be called from user, kernel or interrupt context.
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fISTREAMS Programming Guide\fR