summaryrefslogtreecommitdiff
path: root/usr/src/man/man3head/stat.h.3head
blob: deadaf3a9e8f156c227be0d20d54d5066175f3c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
'\" te
.\" Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved
.\" Copyright 1989 AT&T
.\" 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. 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. 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]
.TH stat.h 3HEAD "1 Sep 2009" "SunOS 5.11" "Headers"
.SH NAME
stat.h, stat \- data returned by stat system call
.SH SYNOPSIS
.LP
.nf
#include <sys/types.h>
#include <sys/stat.h>
.fi

.SH DESCRIPTION
.sp
.LP
The system calls \fBstat()\fR, \fBlstat()\fR and \fBfstat()\fR return data in a
\fBstat\fR structure, which is defined in <\fBstat.h\fR>.
.sp
.LP
The constants used in the \fBst_mode\fR field are also defined in this file:
.sp

.sp
.TS
tab();
lw(.81i) lw(1.38i) lw(3.32i) 
lw(.81i) lw(1.38i) lw(3.32i) 
.
#defineS_IFMT/* type of file */
#defineS_IAMB/* access mode bits */
#defineS_IFIFO/* fifo */
#defineS_IFCHR/* character special */
#defineS_IFDIR/* directory */
#defineS_IFNAM/* \fBXENIX\fR special named file */ 
#defineS_INSEM/* \fBXENIX\fR semaphore subtype of \fBIFNAM\fR */
#defineS_INSHD/* \fBXENIX\fR shared data subtype of \fBIFNAM\fR */
#defineS_IFBLK/* block special */
#defineS_IFREG/* regular */
#defineS_IFLNK/* symbolic link */
#defineS_IFSOCK/* socket */
#defineS_IFDOOR/* door */
#defineS_ISUID/* set user id on execution */
#defineS_ISGID/* set group id on execution */
#defineS_ISVTX/* save swapped text even after use */
#defineS_IREAD/* read permission, owner */
#defineS_IWRITE/* write permission, owner */
#defineS_IEXEC/* execute/search permission, owner */
#defineS_ENFMT/* record locking enforcement flag */
#defineS_IRWXU/* read, write, execute: owner */
#defineS_IRUSR/* read permission: owner */
#defineS_IWUSR/* write permission: owner */
#defineS_IXUSR/* execute permission: owner */
#defineS_IRWXG/* read, write, execute: group */
#defineS_IRGRP/* read permission: group */
#defineS_IWGRP/* write permission: group */
#defineS_IXGRP/* execute permission: group */
#defineS_IRWXO/* read, write, execute: other */
#defineS_IROTH/* read permission: other */
#defineS_IWOTH/* write permission: other */
#defineS_IXOTH/* execute permission: other */
.TE

.sp
.LP
The following macros are for POSIX conformance (see \fBstandards\fR(5)):
.sp

.sp
.TS
tab();
lw(.78i) lw(1.43i) lw(3.29i) 
lw(.78i) lw(1.43i) lw(3.29i) 
.
#defineS_ISBLK(mode)block special file
#defineS_ISCHR(mode)character special file
#defineS_ISDIR(mode)directory file
#defineS_ISFIFO(mode)pipe or fifo file
#defineS_ISREG(mode)regular file
#defineS_ISSOCK(mode)socket file
.TE

.sp
.LP
The following symbolic constants are defined as distinct integer values outside
of the range [0, 999 999 999], for use with the \fBfutimens()\fR and
\fButimensat()\fR functions:
.sp
.in +2
.nf
#define    UTIME_NOW        use the current time
@define    UTIME_OMIT       no time change
.fi
.in -2

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBfutimens\fR(2), \fBstat\fR(2), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5),
\fBstandards\fR(5)