usr/src/man/man3head/stddef.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\" Copyright 2016, Joyent, Inc.
  46 .\"
  47 .TH STDDEF.H 3HEAD "Jan 14, 2015"
  48 .SH NAME
  49 stddef.h, stddef \- standard type definitions
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <\fBstddef.h\fR>
  54 .fi
  55
  56 .SH DESCRIPTION
  57 .LP
  58 The <\fBstddef.h\fR> header defines the following macros:
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBNULL\fR\fR
  63 .ad
  64 .sp .6
  65 .RS 4n
  66 Null pointer constant.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBoffsetof(type, member-designator)\fR\fR
  73 .ad
  74 .sp .6
  75 .RS 4n
  76 Integer constant expression of type \fBsize_t\fR, the value of which is the
  77 offset in bytes to the structure member (\fBmember-designator\fR), from the
  78 beginning of its structure (\fBtype\fR).
  79 .RE
  80
  81 .sp
  82 .LP
  83 The <\fBstddef.h\fR> header defines the following types:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBptrdiff_t\fR\fR
  88 .ad
  89 .RS 13n
  90 Signed integer type of the result of subtracting two pointers.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBwchar_t\fR\fR
  97 .ad
  98 .RS 13n
  99 Integer type whose range of values can represent distinct wide-character codes
 100 for all members of the largest character set specified among the locales
 101 supported by the compilation environment: the null character has the code value
 102 0 and each member of the portable character set has a code value equal to its
 103 value when used as the lone character in an integer character constant.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBsize_t\fR\fR
 110 .ad
 111 .RS 13n
 112 Unsigned integer type of the result of the \fBsizeof\fR operator.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 .B max_align_t
 119 .ad
 120 .RS 13n
 121 A type that represents the maximum alignment supported by the platform.
 122 The type may or may not be an integer type, it may or may not be signed,
 123 no assumptions should be made, other than that it has the maximum
 124 fundamental alignment of the platform.
 125 .RE
 126
 127 .sp
 128 .LP
 129 The implementation supports one or more programming environments in which the
 130 widths of \fBptrdiff_t\fR, \fBsize_t\fR, and \fBwchar_t\fR are no greater than
 131 the width of type \fBlong\fR. The names of these programming environments can
 132 be obtained using the \fBconfstr\fR(3C) function or the \fBgetconf\fR(1)
 133 utility.
 134 .SH ATTRIBUTES
 135 .LP
 136 See \fBattributes\fR(5) for descriptions of the following attributes:
 137 .sp
 138
 139 .sp
 140 .TS
 141 box;
 142 c | c
 143 l | l .
 144 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 145 _
 146 Interface Stability     Standard
 147 .TE
 148
 149 .SH SEE ALSO
 150 .LP
 151 \fBgetconf\fR(1), \fBconfstr\fR(3C), \fBtypes.h\fR(3HEAD),
 152 \fBwchar.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)