1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<link rel="stylesheet" href="style.css" type="text/css">
5<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6<meta name="viewport" content="width=device-width, initial-scale=1">
7<link rel="Start" href="index.html">
8<link rel="Up" href="UnixLabels.html">
9<link title="Index of types" rel=Appendix href="index_types.html">
10<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
11<link title="Index of values" rel=Appendix href="index_values.html">
12<link title="Index of modules" rel=Appendix href="index_modules.html">
13<link title="Index of module types" rel=Appendix href="index_module_types.html">
14<link title="Arg" rel="Chapter" href="Arg.html">
15<link title="Arg_helper" rel="Chapter" href="Arg_helper.html">
16<link title="Arith_status" rel="Chapter" href="Arith_status.html">
17<link title="Array" rel="Chapter" href="Array.html">
18<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
19<link title="Ast_helper" rel="Chapter" href="Ast_helper.html">
20<link title="Ast_invariants" rel="Chapter" href="Ast_invariants.html">
21<link title="Ast_iterator" rel="Chapter" href="Ast_iterator.html">
22<link title="Ast_mapper" rel="Chapter" href="Ast_mapper.html">
23<link title="Asttypes" rel="Chapter" href="Asttypes.html">
24<link title="Attr_helper" rel="Chapter" href="Attr_helper.html">
25<link title="Big_int" rel="Chapter" href="Big_int.html">
26<link title="Bigarray" rel="Chapter" href="Bigarray.html">
27<link title="Buffer" rel="Chapter" href="Buffer.html">
28<link title="Builtin_attributes" rel="Chapter" href="Builtin_attributes.html">
29<link title="Bytes" rel="Chapter" href="Bytes.html">
30<link title="BytesLabels" rel="Chapter" href="BytesLabels.html">
31<link title="Callback" rel="Chapter" href="Callback.html">
32<link title="CamlinternalFormat" rel="Chapter" href="CamlinternalFormat.html">
33<link title="CamlinternalFormatBasics" rel="Chapter" href="CamlinternalFormatBasics.html">
34<link title="CamlinternalLazy" rel="Chapter" href="CamlinternalLazy.html">
35<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
36<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
37<link title="Ccomp" rel="Chapter" href="Ccomp.html">
38<link title="Char" rel="Chapter" href="Char.html">
39<link title="Clflags" rel="Chapter" href="Clflags.html">
40<link title="Complex" rel="Chapter" href="Complex.html">
41<link title="Condition" rel="Chapter" href="Condition.html">
42<link title="Config" rel="Chapter" href="Config.html">
43<link title="Consistbl" rel="Chapter" href="Consistbl.html">
44<link title="Depend" rel="Chapter" href="Depend.html">
45<link title="Digest" rel="Chapter" href="Digest.html">
46<link title="Docstrings" rel="Chapter" href="Docstrings.html">
47<link title="Dynlink" rel="Chapter" href="Dynlink.html">
48<link title="Ephemeron" rel="Chapter" href="Ephemeron.html">
49<link title="Event" rel="Chapter" href="Event.html">
50<link title="Filename" rel="Chapter" href="Filename.html">
51<link title="Format" rel="Chapter" href="Format.html">
52<link title="Gc" rel="Chapter" href="Gc.html">
53<link title="Genlex" rel="Chapter" href="Genlex.html">
54<link title="Graphics" rel="Chapter" href="Graphics.html">
55<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
56<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
57<link title="Identifiable" rel="Chapter" href="Identifiable.html">
58<link title="Int32" rel="Chapter" href="Int32.html">
59<link title="Int64" rel="Chapter" href="Int64.html">
60<link title="Lazy" rel="Chapter" href="Lazy.html">
61<link title="Lexer" rel="Chapter" href="Lexer.html">
62<link title="Lexing" rel="Chapter" href="Lexing.html">
63<link title="List" rel="Chapter" href="List.html">
64<link title="ListLabels" rel="Chapter" href="ListLabels.html">
65<link title="Location" rel="Chapter" href="Location.html">
66<link title="Longident" rel="Chapter" href="Longident.html">
67<link title="Map" rel="Chapter" href="Map.html">
68<link title="Marshal" rel="Chapter" href="Marshal.html">
69<link title="Misc" rel="Chapter" href="Misc.html">
70<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
71<link title="Mutex" rel="Chapter" href="Mutex.html">
72<link title="Nativeint" rel="Chapter" href="Nativeint.html">
73<link title="Num" rel="Chapter" href="Num.html">
74<link title="Numbers" rel="Chapter" href="Numbers.html">
75<link title="Obj" rel="Chapter" href="Obj.html">
76<link title="Oo" rel="Chapter" href="Oo.html">
77<link title="Parse" rel="Chapter" href="Parse.html">
78<link title="Parser" rel="Chapter" href="Parser.html">
79<link title="Parsetree" rel="Chapter" href="Parsetree.html">
80<link title="Parsing" rel="Chapter" href="Parsing.html">
81<link title="Pervasives" rel="Chapter" href="Pervasives.html">
82<link title="Pprintast" rel="Chapter" href="Pprintast.html">
83<link title="Printast" rel="Chapter" href="Printast.html">
84<link title="Printexc" rel="Chapter" href="Printexc.html">
85<link title="Printf" rel="Chapter" href="Printf.html">
86<link title="Queue" rel="Chapter" href="Queue.html">
87<link title="Random" rel="Chapter" href="Random.html">
88<link title="Ratio" rel="Chapter" href="Ratio.html">
89<link title="Scanf" rel="Chapter" href="Scanf.html">
90<link title="Set" rel="Chapter" href="Set.html">
91<link title="Sort" rel="Chapter" href="Sort.html">
92<link title="Spacetime" rel="Chapter" href="Spacetime.html">
93<link title="Stack" rel="Chapter" href="Stack.html">
94<link title="StdLabels" rel="Chapter" href="StdLabels.html">
95<link title="Str" rel="Chapter" href="Str.html">
96<link title="Stream" rel="Chapter" href="Stream.html">
97<link title="String" rel="Chapter" href="String.html">
98<link title="StringLabels" rel="Chapter" href="StringLabels.html">
99<link title="Strongly_connected_components" rel="Chapter" href="Strongly_connected_components.html">
100<link title="Syntaxerr" rel="Chapter" href="Syntaxerr.html">
101<link title="Sys" rel="Chapter" href="Sys.html">
102<link title="Targetint" rel="Chapter" href="Targetint.html">
103<link title="Tbl" rel="Chapter" href="Tbl.html">
104<link title="Terminfo" rel="Chapter" href="Terminfo.html">
105<link title="Thread" rel="Chapter" href="Thread.html">
106<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
107<link title="Timings" rel="Chapter" href="Timings.html">
108<link title="Uchar" rel="Chapter" href="Uchar.html">
109<link title="Unix" rel="Chapter" href="Unix.html">
110<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
111<link title="Warnings" rel="Chapter" href="Warnings.html">
112<link title="Weak" rel="Chapter" href="Weak.html"><title>UnixLabels.LargeFile</title>
113</head>
114<body>
115<div class="navbar">&nbsp;<a class="up" href="UnixLabels.html" title="UnixLabels">Up</a>
116&nbsp;</div>
117<h1>Module <a href="type_UnixLabels.LargeFile.html">UnixLabels.LargeFile</a></h1>
118
119<pre><span class="keyword">module</span> LargeFile: <code class="code"><span class="keyword">sig</span></code> <a href="UnixLabels.LargeFile.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
120File operations on large files.
121  This sub-module provides 64-bit variants of the functions
122  <a href="UnixLabels.html#VALlseek"><code class="code"><span class="constructor">UnixLabels</span>.lseek</code></a> (for positioning a file descriptor),
123  <a href="UnixLabels.html#VALtruncate"><code class="code"><span class="constructor">UnixLabels</span>.truncate</code></a> and <a href="UnixLabels.html#VALftruncate"><code class="code"><span class="constructor">UnixLabels</span>.ftruncate</code></a>
124  (for changing the size of a file),
125  and <a href="UnixLabels.html#VALstat"><code class="code"><span class="constructor">UnixLabels</span>.stat</code></a>, <a href="UnixLabels.html#VALlstat"><code class="code"><span class="constructor">UnixLabels</span>.lstat</code></a> and <a href="UnixLabels.html#VALfstat"><code class="code"><span class="constructor">UnixLabels</span>.fstat</code></a>
126  (for obtaining information on files).  These alternate functions represent
127  positions and sizes by 64-bit integers (type <code class="code">int64</code>) instead of
128  regular integers (type <code class="code">int</code>), thus allowing operating on files
129  whose sizes are greater than <code class="code">max_int</code>.<br>
130</div>
131<hr width="100%">
132
133<pre><span id="VALlseek"><span class="keyword">val</span> lseek</span> : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">UnixLabels.file_descr</a> -> int64 -> mode:<a href="UnixLabels.html#TYPEseek_command">UnixLabels.seek_command</a> -> int64</code></pre>
134<pre><span id="VALtruncate"><span class="keyword">val</span> truncate</span> : <code class="type">string -> len:int64 -> unit</code></pre>
135<pre><span id="VALftruncate"><span class="keyword">val</span> ftruncate</span> : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">UnixLabels.file_descr</a> -> len:int64 -> unit</code></pre>
136<pre><span id="TYPEstats"><span class="keyword">type</span> <code class="type"></code>stats</span> = <code class="type"><a href="Unix.LargeFile.html#TYPEstats">Unix.LargeFile.stats</a></code> = {</pre><table class="typetable">
137<tr>
138<td align="left" valign="top" >
139<code>&nbsp;&nbsp;</code></td>
140<td align="left" valign="top" >
141<code><span id="TYPEELTstats.st_dev">st_dev</span>&nbsp;: <code class="type">int</code>;</code></td>
142<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
143Device number<br>
144</div>
145</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
146</tr>
147<tr>
148<td align="left" valign="top" >
149<code>&nbsp;&nbsp;</code></td>
150<td align="left" valign="top" >
151<code><span id="TYPEELTstats.st_ino">st_ino</span>&nbsp;: <code class="type">int</code>;</code></td>
152<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
153Inode number<br>
154</div>
155</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
156</tr>
157<tr>
158<td align="left" valign="top" >
159<code>&nbsp;&nbsp;</code></td>
160<td align="left" valign="top" >
161<code><span id="TYPEELTstats.st_kind">st_kind</span>&nbsp;: <code class="type"><a href="UnixLabels.html#TYPEfile_kind">UnixLabels.file_kind</a></code>;</code></td>
162<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
163Kind of the file<br>
164</div>
165</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
166</tr>
167<tr>
168<td align="left" valign="top" >
169<code>&nbsp;&nbsp;</code></td>
170<td align="left" valign="top" >
171<code><span id="TYPEELTstats.st_perm">st_perm</span>&nbsp;: <code class="type"><a href="UnixLabels.html#TYPEfile_perm">UnixLabels.file_perm</a></code>;</code></td>
172<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
173Access rights<br>
174</div>
175</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
176</tr>
177<tr>
178<td align="left" valign="top" >
179<code>&nbsp;&nbsp;</code></td>
180<td align="left" valign="top" >
181<code><span id="TYPEELTstats.st_nlink">st_nlink</span>&nbsp;: <code class="type">int</code>;</code></td>
182<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
183Number of links<br>
184</div>
185</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
186</tr>
187<tr>
188<td align="left" valign="top" >
189<code>&nbsp;&nbsp;</code></td>
190<td align="left" valign="top" >
191<code><span id="TYPEELTstats.st_uid">st_uid</span>&nbsp;: <code class="type">int</code>;</code></td>
192<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
193User id of the owner<br>
194</div>
195</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
196</tr>
197<tr>
198<td align="left" valign="top" >
199<code>&nbsp;&nbsp;</code></td>
200<td align="left" valign="top" >
201<code><span id="TYPEELTstats.st_gid">st_gid</span>&nbsp;: <code class="type">int</code>;</code></td>
202<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
203Group ID of the file's group<br>
204</div>
205</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
206</tr>
207<tr>
208<td align="left" valign="top" >
209<code>&nbsp;&nbsp;</code></td>
210<td align="left" valign="top" >
211<code><span id="TYPEELTstats.st_rdev">st_rdev</span>&nbsp;: <code class="type">int</code>;</code></td>
212<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
213Device minor number<br>
214</div>
215</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
216</tr>
217<tr>
218<td align="left" valign="top" >
219<code>&nbsp;&nbsp;</code></td>
220<td align="left" valign="top" >
221<code><span id="TYPEELTstats.st_size">st_size</span>&nbsp;: <code class="type">int64</code>;</code></td>
222<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
223Size in bytes<br>
224</div>
225</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
226</tr>
227<tr>
228<td align="left" valign="top" >
229<code>&nbsp;&nbsp;</code></td>
230<td align="left" valign="top" >
231<code><span id="TYPEELTstats.st_atime">st_atime</span>&nbsp;: <code class="type">float</code>;</code></td>
232<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
233Last access time<br>
234</div>
235</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
236</tr>
237<tr>
238<td align="left" valign="top" >
239<code>&nbsp;&nbsp;</code></td>
240<td align="left" valign="top" >
241<code><span id="TYPEELTstats.st_mtime">st_mtime</span>&nbsp;: <code class="type">float</code>;</code></td>
242<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
243Last modification time<br>
244</div>
245</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
246</tr>
247<tr>
248<td align="left" valign="top" >
249<code>&nbsp;&nbsp;</code></td>
250<td align="left" valign="top" >
251<code><span id="TYPEELTstats.st_ctime">st_ctime</span>&nbsp;: <code class="type">float</code>;</code></td>
252<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
253Last status change time<br>
254</div>
255</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
256</tr></table>
257}
258
259
260
261<pre><span id="VALstat"><span class="keyword">val</span> stat</span> : <code class="type">string -> <a href="UnixLabels.LargeFile.html#TYPEstats">stats</a></code></pre>
262<pre><span id="VALlstat"><span class="keyword">val</span> lstat</span> : <code class="type">string -> <a href="UnixLabels.LargeFile.html#TYPEstats">stats</a></code></pre>
263<pre><span id="VALfstat"><span class="keyword">val</span> fstat</span> : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">UnixLabels.file_descr</a> -> <a href="UnixLabels.LargeFile.html#TYPEstats">stats</a></code></pre></body></html>