1 <Type Name="Stdlib" FullName="Mono.Unix.Native.Stdlib">
2 <TypeSignature Language="C#" Value="public class Stdlib" />
3 <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Stdlib extends System.Object" />
5 <AssemblyName>Mono.Posix</AssemblyName>
6 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
7 <AssemblyVersion>2.0.0.0</AssemblyVersion>
8 <AssemblyVersion>4.0.0.0</AssemblyVersion>
10 <ThreadingSafetyStatement>All public static members of this type are
11 probably safe for multithreaded operations within managed code. (Methods
12 which are obviously unsafe are synchronized, such as
13 <see cref="M:Mono.Unix.Native.Stdlib.strerror" />, but any hidden dependencies
15 <see cref="M:Mono.Unix.Native.Stdlib.strerror" /> and
16 <see cref="M:Mono.Unix.Native.Stdlib.fopen" /> are not protected.)
17 No multithreading guarantee is made between managed and unmanaged code.
18 Check your operating system documentation for more information.
19 </ThreadingSafetyStatement>
21 <BaseTypeName>System.Object</BaseTypeName>
25 <summary>C Standard Library functions.</summary>
26 <remarks>The Stdlib class exports only functions that are part of the standard C library, from the ISO-9899 standard (C99). As such, exports should be portable to any operating system supporting the standard C library, such as Microsoft Windows, as opposed to <see cref="T:Mono.Unix.Native.Syscall" /> which only supports Unix-like operating systems.</remarks>
29 <Member MemberName="_Exit">
30 <MemberSignature Language="C#" Value="public static void _Exit (int status);" />
31 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "_Exit" cdecl)void _Exit(int32 status) cil managed" />
32 <MemberType>Method</MemberType>
34 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
35 <AssemblyVersion>2.0.0.0</AssemblyVersion>
36 <AssemblyVersion>4.0.0.0</AssemblyVersion>
40 <AttributeName>System.CLSCompliant(false)</AttributeName>
44 <ReturnType>System.Void</ReturnType>
47 <Parameter Name="status" Type="System.Int32" />
50 <param name="status">The low-order eight bits of <paramref name="status" /> are generally made available to a parent process.</param>
51 <summary>Perform normal program termination.</summary>
54 The <c>_Exit</c>(3) function terminates without calling the functions registered with the <see cref="M:Mono.Unix.Native.Stdlib.atexit" />(3) function, and may or may not perform the other actions listed in <see cref="M:Mono.Unix.Native.Stdlib.exit" />(3).
57 The C Standard (ISO/IEC 9899:1999 ("ISO C99")) defines the values 0, <see cref="F:Mono.Unix.Native.Stdlib.EXIT_SUCCESS" />, and <see cref="F:Mono.Unix.Native.Stdlib.EXIT_FAILURE" /> as possible values of <paramref name="status" />. Cooperating processes may use other values; in a program which might be called by a mail transfer agent, the values described in <c>sysexits</c>(3) may be used to provide more information to the parent process.
60 This function never returns.
65 <Member MemberName="_IOFBF">
66 <MemberSignature Language="C#" Value="public static readonly int _IOFBF;" />
67 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 _IOFBF" />
68 <MemberType>Field</MemberType>
70 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
71 <AssemblyVersion>2.0.0.0</AssemblyVersion>
72 <AssemblyVersion>4.0.0.0</AssemblyVersion>
76 <AttributeName>System.CLSCompliant(false)</AttributeName>
80 <ReturnType>System.Int32</ReturnType>
82 <MemberValue>0</MemberValue>
84 <summary>Fully Buffered.</summary>
85 <remarks>To be added.</remarks>
88 <Member MemberName="_IOLBF">
89 <MemberSignature Language="C#" Value="public static readonly int _IOLBF;" />
90 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 _IOLBF" />
91 <MemberType>Field</MemberType>
93 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
94 <AssemblyVersion>2.0.0.0</AssemblyVersion>
95 <AssemblyVersion>4.0.0.0</AssemblyVersion>
99 <AttributeName>System.CLSCompliant(false)</AttributeName>
103 <ReturnType>System.Int32</ReturnType>
105 <MemberValue>1</MemberValue>
107 <summary>Line buffered.</summary>
108 <remarks>To be added.</remarks>
111 <Member MemberName="_IONBF">
112 <MemberSignature Language="C#" Value="public static readonly int _IONBF;" />
113 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 _IONBF" />
114 <MemberType>Field</MemberType>
116 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
117 <AssemblyVersion>2.0.0.0</AssemblyVersion>
118 <AssemblyVersion>4.0.0.0</AssemblyVersion>
122 <AttributeName>System.CLSCompliant(false)</AttributeName>
126 <ReturnType>System.Int32</ReturnType>
128 <MemberValue>2</MemberValue>
130 <summary>Specify unbuffered <c>FILE</c> streams.</summary>
131 <remarks>To be added.</remarks>
134 <Member MemberName="abort">
135 <MemberSignature Language="C#" Value="public static void abort ();" />
136 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "abort" cdecl)void abort() cil managed" />
137 <MemberType>Method</MemberType>
139 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
140 <AssemblyVersion>2.0.0.0</AssemblyVersion>
141 <AssemblyVersion>4.0.0.0</AssemblyVersion>
144 <ReturnType>System.Void</ReturnType>
148 <summary>Cause abnormal program termination.</summary>
150 <para>The <c>abort</c>() function causes abnormal program termination to occur, unless the signal
151 <see cref="F:Mono.Unix.Native.Signum.SIGABRT" /> is being caught and the signal handler does not return.
154 Any open streams are flushed and closed.
156 <para>The <c>abort</c>() function never returns.</para>
160 <Member MemberName="BUFSIZ">
161 <MemberSignature Language="C#" Value="public static readonly int BUFSIZ;" />
162 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 BUFSIZ" />
163 <MemberType>Field</MemberType>
165 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
166 <AssemblyVersion>2.0.0.0</AssemblyVersion>
167 <AssemblyVersion>4.0.0.0</AssemblyVersion>
171 <AttributeName>System.CLSCompliant(false)</AttributeName>
175 <ReturnType>System.Int32</ReturnType>
177 <MemberValue>8192</MemberValue>
179 <summary>Buffer size.</summary>
180 <remarks>To be added.</remarks>
183 <Member MemberName="calloc">
184 <MemberSignature Language="C#" Value="public static IntPtr calloc (ulong nmemb, ulong size);" />
185 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_calloc" cdecl lasterr)native int calloc(unsigned int64 nmemb, unsigned int64 size) cil managed" />
186 <MemberType>Method</MemberType>
188 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
189 <AssemblyVersion>2.0.0.0</AssemblyVersion>
190 <AssemblyVersion>4.0.0.0</AssemblyVersion>
194 <AttributeName>System.CLSCompliant(false)</AttributeName>
198 <ReturnType>System.IntPtr</ReturnType>
201 <Parameter Name="nmemb" Type="System.UInt64" />
202 <Parameter Name="size" Type="System.UInt64" />
205 <param name="nmemb">Number of objects to allocate.</param>
206 <param name="size">Size of each object to allocate.</param>
207 <summary>Allocate and zero-fill memory.</summary>
208 <returns>The <c>calloc</c> function returns a pointer to the allocated memory if successful; otherwise <see cref="F:System.IntPtr.Zero" /> is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> returns <see cref="F:Mono.Unix.Native.Errno.ENOMEM" />.</returns>
211 The <c>calloc</c>() function allocates space for <paramref name="nmemb" /> objects, each <paramref name="size" /> bytes in length. The result is identical to calling <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3) with an argument of "<c>nmemb * size</c>," with the exception that the allocated memory is explicitly initialized to zero bytes.
214 The return value of <c>calloc</c> must be passed to <see cref="M:Mono.Unix.Native.Stdlib.free" /> to avoid a memory leak.
219 <Member MemberName="clearerr">
220 <MemberSignature Language="C#" Value="public static int clearerr (IntPtr stream);" />
221 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_clearerr" cdecl lasterr)int32 clearerr(native int stream) cil managed" />
222 <MemberType>Method</MemberType>
224 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
225 <AssemblyVersion>2.0.0.0</AssemblyVersion>
226 <AssemblyVersion>4.0.0.0</AssemblyVersion>
229 <ReturnType>System.Int32</ReturnType>
232 <Parameter Name="stream" Type="System.IntPtr" />
235 <param name="stream">The <c>FILE</c> stream to clear end-of-file and error indicators on.</param>
236 <summary>Clear <c>FILE</c> stream status.</summary>
237 <returns>The <c>clearerr</c>() function returns the value 0 if successful; otherwise the value -1 is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</returns>
238 <remarks>Clears the end-of-file and error indicators for the stream pointed to by <paramref name="stream" />.</remarks>
241 <Member MemberName="EOF">
242 <MemberSignature Language="C#" Value="public static readonly int EOF;" />
243 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 EOF" />
244 <MemberType>Field</MemberType>
246 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
247 <AssemblyVersion>2.0.0.0</AssemblyVersion>
248 <AssemblyVersion>4.0.0.0</AssemblyVersion>
252 <AttributeName>System.CLSCompliant(false)</AttributeName>
256 <ReturnType>System.Int32</ReturnType>
258 <MemberValue>-1</MemberValue>
260 <summary>End Of File.</summary>
261 <remarks>To be added.</remarks>
264 <Member MemberName="exit">
265 <MemberSignature Language="C#" Value="public static void exit (int status);" />
266 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "exit" cdecl)void exit(int32 status) cil managed" />
267 <MemberType>Method</MemberType>
269 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
270 <AssemblyVersion>2.0.0.0</AssemblyVersion>
271 <AssemblyVersion>4.0.0.0</AssemblyVersion>
274 <ReturnType>System.Void</ReturnType>
277 <Parameter Name="status" Type="System.Int32" />
280 <param name="status">The low-order eight bits of <paramref name="status" /> are generally made available to a parent process.</param>
281 <summary>Terminates the process that calls the function with the exit status <paramref name="status" />.</summary>
283 <para>The <c>exit</c> function terminates a process.</para>
284 <para>Before termination, <c>exit</c>() performs the following functions in the order listed:</para>
287 <term>Call the functions registered with the <see cref="M:Mono.Unix.Native.Stdlib.atexit" />(3) function, in the reverse order of their registration.</term>
290 <term>Flush all open output streams</term>
293 <term>Close all open streams</term>
296 <term>Unlink all files created with the <see cref="M:Mono.Unix.Native.Stdlib.tmpfile" />(3) function.</term>
299 <para>The low-order eight bits of the <paramref name="status" /> argument is made available to a parent process which has called a <see cref="M:Mono.Unix.Native.Syscall.wait" />(2)-family function.
302 The C Standard (ISO/IEC 9899:1999 ("ISO C99")) defines the values 0, <see cref="F:Mono.Unix.Native.Stdlib.EXIT_SUCCESS" />, and <see cref="F:Mono.Unix.Native.Stdlib.EXIT_FAILURE" /> as possible values of <paramref name="status" />. Cooperating processes may use other values; in a program which might be called by a mail transfer agent, the values described in <c>sysexits</c>(3) may be used to provide more information to the parent process.
304 <para>Note that <c>exit</c>() does nothing to prevent bottomless recursion should a function registered using <see cref="M:Mono.Unix.Native.Stdlib.atexit" />(3) itself call <c>exit</c>(). Such functions must call <see cref="M:Mono.Unix.Native.Stdlib._Exit" />() instead
305 (although this has other effects as well which may not be desired).
308 This function never returns.
313 using Mono.Unix.Native;
314 using System.Runtime.InteropServices;
318 public void SignalCatcher(int v)
320 // sleep signal caught.
321 Console.WriteLine("Signal received: " + v);
322 // this line will not be printed because process exits...
323 Console.WriteLine("Exiting with: " + Stdlib.exit(9));
326 public static void Main(string[] args)
329 Console.Write("waiting for event...");
330 string x = Console.ReadLine();
335 // create a signal handler delegate for sleep signals
336 Console.WriteLine("signal result: " +
337 Syscall.signal(Signum.SIGALRM,
338 new SignalHandler (SignalCatcher)));
339 // send a sleep signal
347 <Member MemberName="EXIT_FAILURE">
348 <MemberSignature Language="C#" Value="public static readonly int EXIT_FAILURE;" />
349 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 EXIT_FAILURE" />
350 <MemberType>Field</MemberType>
352 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
353 <AssemblyVersion>2.0.0.0</AssemblyVersion>
354 <AssemblyVersion>4.0.0.0</AssemblyVersion>
358 <AttributeName>System.CLSCompliant(false)</AttributeName>
362 <ReturnType>System.Int32</ReturnType>
364 <MemberValue>1</MemberValue>
366 <summary>Failure program exit status.</summary>
367 <remarks>This is the value to return from <c>Main</c> when an error occurs.</remarks>
370 <Member MemberName="EXIT_SUCCESS">
371 <MemberSignature Language="C#" Value="public static readonly int EXIT_SUCCESS;" />
372 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 EXIT_SUCCESS" />
373 <MemberType>Field</MemberType>
375 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
376 <AssemblyVersion>2.0.0.0</AssemblyVersion>
377 <AssemblyVersion>4.0.0.0</AssemblyVersion>
381 <AttributeName>System.CLSCompliant(false)</AttributeName>
385 <ReturnType>System.Int32</ReturnType>
387 <MemberValue>0</MemberValue>
389 <summary>Success program exit status.</summary>
390 <remarks>This is the value to return from <c>Main</c> when no errors occur.</remarks>
393 <Member MemberName="fclose">
394 <MemberSignature Language="C#" Value="public static int fclose (IntPtr stream);" />
395 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "fclose" cdecl lasterr)int32 fclose(native int stream) cil managed" />
396 <MemberType>Method</MemberType>
398 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
399 <AssemblyVersion>2.0.0.0</AssemblyVersion>
400 <AssemblyVersion>4.0.0.0</AssemblyVersion>
403 <ReturnType>System.Int32</ReturnType>
406 <Parameter Name="stream" Type="System.IntPtr" />
409 <param name="stream">The <c>FILE</c> stream to close.</param>
410 <summary>Close a <c>FILE</c> stream.</summary>
412 <para>Upon successful completion 0 is returned. Otherwise, <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> is returned and the global variable <c>errno</c> is set to indicate the error. In either case no further access to the stream is possible.</para>
413 <para> The <c>fclose</c>() function may also fail and set <c>errno</c> for any of the errors specified for the routines <see cref="M:Mono.Unix.Native.Syscall.close" />(2) or <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3).
417 <para> The <c>fclose</c>() function dissociates the named stream from its underlying file or set of functions. If the stream was being used for output, any buffered data is written first, using <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3).
422 <Member MemberName="feof">
423 <MemberSignature Language="C#" Value="public static int feof (IntPtr stream);" />
424 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "feof" cdecl)int32 feof(native int stream) cil managed" />
425 <MemberType>Method</MemberType>
427 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
428 <AssemblyVersion>2.0.0.0</AssemblyVersion>
429 <AssemblyVersion>4.0.0.0</AssemblyVersion>
432 <ReturnType>System.Int32</ReturnType>
435 <Parameter Name="stream" Type="System.IntPtr" />
438 <param name="stream">The <c>FILE</c> stream on which to test the end-of-file indicator.</param>
439 <summary>Test end-of-file indicator for the <c>FILE</c> stream.</summary>
440 <returns>Returns non-zero if the end-of-stream indicator for <paramref name="stream" /> is set. Otherwise, 0 is returned.</returns>
441 <remarks>The function <c>feof</c>() tests the end-of-file indicator for the stream pointed to by stream, returning non-zero if it is set. The end-of-file indicator can only be cleared by the function <see cref="M:Mono.Unix.Native.Stdlib.clearerr" />().</remarks>
444 <Member MemberName="ferror">
445 <MemberSignature Language="C#" Value="public static int ferror (IntPtr stream);" />
446 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "ferror" cdecl)int32 ferror(native int stream) cil managed" />
447 <MemberType>Method</MemberType>
449 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
450 <AssemblyVersion>2.0.0.0</AssemblyVersion>
451 <AssemblyVersion>4.0.0.0</AssemblyVersion>
454 <ReturnType>System.Int32</ReturnType>
457 <Parameter Name="stream" Type="System.IntPtr" />
460 <param name="stream">The <c>FILE</c> stream on which to test the error indicator.</param>
461 <summary>Tests the error indicator for the <c>FILE</c> stream.</summary>
462 <returns>Returns non-zero if the error indicator is set on <paramref name="stream" />. Otherwise, 0 is returned.</returns>
463 <remarks>The function <c>ferror</c>() tests the error indicator for the stream pointed to by stream, returning non-zero if it is set. The error indicator can only be reset by the <see cref="M:Mono.Unix.Native.Stdlib.clearerr" />() function.</remarks>
466 <Member MemberName="fflush">
467 <MemberSignature Language="C#" Value="public static int fflush (IntPtr stream);" />
468 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "fflush" cdecl lasterr)int32 fflush(native int stream) cil managed" />
469 <MemberType>Method</MemberType>
471 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
472 <AssemblyVersion>2.0.0.0</AssemblyVersion>
473 <AssemblyVersion>4.0.0.0</AssemblyVersion>
476 <ReturnType>System.Int32</ReturnType>
479 <Parameter Name="stream" Type="System.IntPtr" />
482 <param name="stream">The <c>FILE</c> stream to flush.</param>
483 <summary>Flush a <c>FILE</c> stream.</summary>
484 <returns>Upon successful completion 0 is returned. Otherwise, <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> is returned and the global variable <c>errno</c> is set to indicate the error.
486 <block subset="none" type="usage"><para>The following errors are specified:</para><list type="table"><listheader><term>Error</term><description>Details</description></listheader><item><term><see cref="F:Mono.Unix.Native.Errno.EBADF" /></term><description>The <paramref name="stream" /> argument is not an open stream, or not a stream open for writing.</description></item></list><para>The function <c>fflush</c> may also fail and set <c>errno</c> for any of the errors specified for <see cref="M:Mono.Unix.Native.Syscall.write" />(2).</para></block></returns>
488 <para> The function <c>fflush</c>() forces a write of all buffered data for the given output or update <paramref name="stream" /> via the stream's underlying write function. The open status of the stream is unaffected.</para>
489 <para>If the stream argument is <see cref="F:System.IntPtr.Zero" />, <c>fflush</c>() flushes all open output streams.</para>
493 <Member MemberName="fgetc">
494 <MemberSignature Language="C#" Value="public static int fgetc (IntPtr stream);" />
495 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "fgetc" cdecl lasterr)int32 fgetc(native int stream) cil managed" />
496 <MemberType>Method</MemberType>
498 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
499 <AssemblyVersion>2.0.0.0</AssemblyVersion>
500 <AssemblyVersion>4.0.0.0</AssemblyVersion>
503 <ReturnType>System.Int32</ReturnType>
506 <Parameter Name="stream" Type="System.IntPtr" />
509 <param name="stream">
510 <c>FILE</c> stream to read a character from.</param>
511 <summary>Get next character from a <c>FILE</c> input stream.</summary>
512 <returns> If successful, returns the next requested object from the stream. Character values are returned as an unsigned char converted to an int. If the stream is at end-of-file or a read error occurs, the routines return <see cref="M:Mono.Unix.Native.Stdlib.EOF" />. The routines <see cref="M:Mono.Unix.Native.Stdlib.feof" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ferror" />(3) must be used to distinguish between end-of-file and error. If an error occurs, use <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error. The end-of-file condition is remembered, even on a terminal, and all subsequent attempts to read will return <see cref="M:Mono.Unix.Native.Stdlib.EOF" /> until the condition is cleared with <see cref="M:Mono.Unix.Native.Stdlib.clearerr" />(3).</returns>
513 <remarks>The <c>fgetc</c>() function obtains the next input character (if present) from the stream pointed at by stream, or the next character pushed back on the stream via <see cref="M:Mono.Unix.Native.Stdlib.ungetc" />(3).</remarks>
516 <Member MemberName="fgetpos">
517 <MemberSignature Language="C#" Value="public static int fgetpos (IntPtr stream, Mono.Unix.Native.FilePosition pos);" />
518 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 fgetpos(native int stream, class Mono.Unix.Native.FilePosition pos) cil managed" />
519 <MemberType>Method</MemberType>
521 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
522 <AssemblyVersion>2.0.0.0</AssemblyVersion>
523 <AssemblyVersion>4.0.0.0</AssemblyVersion>
526 <ReturnType>System.Int32</ReturnType>
529 <Parameter Name="stream" Type="System.IntPtr" />
530 <Parameter Name="pos" Type="Mono.Unix.Native.FilePosition" />
533 <param name="stream">
534 <c>FILE</c> stream to retreive the current file position for.</param>
535 <param name="pos">Where to store the current file position.</param>
536 <summary>Retrieve the current file position of a <c>FILE</c> stream.</summary>
538 <para>Returns <c>0</c> if successful; otherwise <c>-1</c> is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
539 <block subset="none" type="usage">
540 <para>The following errors are specified:</para>
544 <description>Details</description>
548 <see cref="F:Mono.Unix.Native.Errno.EBADF" />
550 <description>The <paramref name="stream" /> argument is not not a seekable stream</description>
554 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
556 <description>The <paramref name="whence" /> argument is invalid or the resulting file-position indicator would be set to a negative value.</description>
560 <see cref="F:Mono.Unix.Native.Errno.EOVERFLOW" />
562 <description>The resulting file offset would be a value which cannot be represented correctly in an object of type <see cref="System.Int64" /> for <see cref="M:Mono.Unix.Native.Stdlib.fseek" />() and <see cref="M:Mono.Unix.Native.Stdlib.ftell" />().</description>
566 <see cref="F:Mono.Unix.Native.Errno.ESPIPE" />
568 <description>The file descriptor underlying stream is associated with a pipe or FIFO or file-position indicator value is unspecified (see <see cref="M:Mono.Unix.Native.Stdlib.ungetc" />(3)).</description>
573 <c>fgetpos</c> may also fail for any of the error specified for the routines <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3), <see cref="M:Mono.Unix.Native.Syscall.fstat" />(2), <see cref="M:Mono.Unix.Native.Syscall.lseek" />(2), and <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3)
577 <para>The <c>fgetpos</c>() is an alternate interfaces for retrieving the current position in the file, similar to <see cref="M:Mono.Unix.Native.Stdlib.ftell" />(), except that the current position is stored in an opaque object of type <see cref="T:Mono.Unix.Native.FilePosition" /> pointed to by pos. This provides a portable way to seek to offsets larger than those that can be represented by a long int. They may also store additional state information in the <see cref="T:Mono.Unix.Native.FilePosition" /> object to facilitate seeking within files containing multibyte characters with state-dependent encodings.</para>
578 <block subset="none" type="note">The value of <paramref name="pos" /> is modified by this operation.
583 <Member MemberName="fgets">
584 <MemberSignature Language="C#" Value="public static System.Text.StringBuilder fgets (System.Text.StringBuilder sb, IntPtr stream);" />
585 <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Text.StringBuilder fgets(class System.Text.StringBuilder sb, native int stream) cil managed" />
586 <MemberType>Method</MemberType>
588 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
589 <AssemblyVersion>2.0.0.0</AssemblyVersion>
590 <AssemblyVersion>4.0.0.0</AssemblyVersion>
593 <ReturnType>System.Text.StringBuilder</ReturnType>
596 <Parameter Name="sb" Type="System.Text.StringBuilder" />
597 <Parameter Name="stream" Type="System.IntPtr" />
600 <param name="sb">Where to store the next line of text from <paramref name="stream" />.</param>
601 <param name="stream">The <c>FILE</c> stream to read a line from.</param>
602 <summary>Read a line from a <c>FILE</c> stream.</summary>
603 <returns>See the <see cref="M:Mono.Unix.Native.Stdlib.fgets(System.Text.StringBuilder,int,System.IntPtr)" /> documentation.</returns>
604 <remarks>Identical to calling <c>fgets(<paramref name="sb" />, <paramref name="sb" />.Capacity, <paramref name="stream" />)</c>.
605 See the <see cref="M:Mono.Unix.Native.Stdlib.fgets(System.Text.StringBuilder,int,System.IntPtr)" /> documentation.</remarks>
608 <Member MemberName="fgets">
609 <MemberSignature Language="C#" Value="public static System.Text.StringBuilder fgets (System.Text.StringBuilder sb, int size, IntPtr stream);" />
610 <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Text.StringBuilder fgets(class System.Text.StringBuilder sb, int32 size, native int stream) cil managed" />
611 <MemberType>Method</MemberType>
613 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
614 <AssemblyVersion>2.0.0.0</AssemblyVersion>
615 <AssemblyVersion>4.0.0.0</AssemblyVersion>
618 <ReturnType>System.Text.StringBuilder</ReturnType>
621 <Parameter Name="sb" Type="System.Text.StringBuilder" />
622 <Parameter Name="size" Type="System.Int32" />
623 <Parameter Name="stream" Type="System.IntPtr" />
626 <param name="sb">Where to store the next line of text from <paramref name="stream" />.</param>
627 <param name="size">The maximum number of characters that <paramref name="sb" /> can hold.</param>
628 <param name="stream">The <c>FILE</c> stream to read a line from.</param>
629 <summary>Read a line from a <c>FILE</c> stream.</summary>
631 <para>Upon successful completion, returns <paramref name="sb" />. If end-of-file occurs before any characters are read, returns <see langword="null" /> and the contents of <paramref name="sb" /> remains unchanged. If an error occurs, <see langword="null" /> is returned and the contents of <paramref name="sb" /> are indeterminate. <c>fgets</c> does not distinguish between end-of-file and error, and callers must use <see cref="M:Mono.Unix.Native.Stdlib.feof" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ferror" />(3) to determine which occurred.</para>
632 <block subset="none" type="usage">
633 <para>The following errors are specified:</para>
637 <description>Details</description>
641 <see cref="F:Mono.Unix.Native.Errno.EBADF" />
643 <description>The given <paramref name="stream" /> is not a readable stream.</description>
648 <c>fgetpos</c> may also fail for any of the error specified for the routines <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3), <see cref="M:Mono.Unix.Native.Syscall.fstat" />(2), <see cref="M:Mono.Unix.Native.Syscall.read" />(2), or <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3).
651 <remarks>The <c>fgets</c>() function reads at most one less than the number of characters specified by <paramref name="size" /> from the given <paramref name="stream" /> and stores them in the string <paramref name="sb" />. Reading stops when a newline character is found, at end-of-file or error. The newline, if any, is retained. If any characters are read and there is no error, a '\0' character is appended to end the string.</remarks>
654 <Member MemberName="FILENAME_MAX">
655 <MemberSignature Language="C#" Value="public static readonly int FILENAME_MAX;" />
656 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 FILENAME_MAX" />
657 <MemberType>Field</MemberType>
659 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
660 <AssemblyVersion>2.0.0.0</AssemblyVersion>
661 <AssemblyVersion>4.0.0.0</AssemblyVersion>
665 <AttributeName>System.CLSCompliant(false)</AttributeName>
669 <ReturnType>System.Int32</ReturnType>
671 <MemberValue>4096</MemberValue>
673 <summary>Maximum filename length.</summary>
674 <remarks>To be added.</remarks>
677 <Member MemberName="fopen">
678 <MemberSignature Language="C#" Value="public static IntPtr fopen (string path, string mode);" />
679 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "fopen" cdecl lasterr)native int fopen(string path, string mode) cil managed" />
680 <MemberType>Method</MemberType>
682 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
683 <AssemblyVersion>2.0.0.0</AssemblyVersion>
684 <AssemblyVersion>4.0.0.0</AssemblyVersion>
687 <ReturnType>System.IntPtr</ReturnType>
690 <Parameter Name="path" Type="System.String" />
691 <Parameter Name="mode" Type="System.String" />
694 <param name="path">The filename to open.</param>
695 <param name="mode">The file mode for opening. See the Remarks section for more details.</param>
696 <summary>Open a file and associate a <c>FILE</c> stream with it.</summary>
698 <para>Upon successful completion, returns a <c>FILE</c> pointer. Otherwise, <see cref="F:System.IntPtr.Zero" /> is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
699 <block subset="none" type="usage">
700 <para>The following errors are specified:</para>
704 <description>Details</description>
708 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
710 <description>The <paramref name="mode" /> argument was invalid.</description>
715 <c>fopen</c> may also fail for any of the error specified for the routines <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3) and <see cref="M:Mono.Unix.Native.Syscall.open" />(2).
719 <para>The fopen() function opens the file whose name is the string pointed to by path and associates a stream with it.
721 <para>Use <see cref="M:Mono.Unix.Native.Stdlib.fclose" /> to close the <c>FILE</c> stream.</para>
722 <para>The argument <paramref name="mode" /> points to a string beginning with one of the following sequences (Additional characters may follow these sequences.):
727 <paramref name="mode" />
729 <description>Description</description>
735 <description> Open text file for reading. The stream is positioned at the beginning of the file.</description>
741 <description>Open for reading and writing. The stream is positioned at the beginning of the file.</description>
747 <description>Truncate file to zero length or create text file for writing. The stream is positioned at the beginning of the file.</description>
753 <description>Open for reading and writing. The file is created if it does not exist, otherwise it is truncated. The stream is positioned at the beginning of the file.</description>
759 <description>Open for writing. The file is created if it does not exist. The stream is positioned at the end of the file. Subsequent writes to the file will always end up at the then current end of file, irrespective of any intervening <see cref="M:Mono.Unix.Native.Stdlib.fseek" />(3) or similar.</description>
765 <description>Open for reading and writing. The file is created if it does not exist. The stream is positioned at the end of the file. Subsequent writes to the file will always end up at the then current end of file, irrespective of any intervening <see cref="M:Mono.Unix.Native.Stdlib.fseek" />(3) or similar.</description>
768 <para>The <paramref name="mode" /> string can also include the letter "b" either as a third character or as a character between the characters in any of the two-character strings described above, and is used to enable <i>binary</i> reading/writing on platforms which have different text/binary encodings (read: Microsoft Windows). The default (non-<c>b</c><paramref name="mode" />) is text encoding.</para>
769 <para>Any created files will have mode <c>S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH</c> (0666), as modified by the process' umask value (see <see cref="M:Mono.Unix.Native.Syscall.umask" />(2)).
771 <para>ANSI C requires that a file positioning function intervene between output and input, unless an input operation encounters end-of-file.</para>
775 <Member MemberName="FOPEN_MAX">
776 <MemberSignature Language="C#" Value="public static readonly int FOPEN_MAX;" />
777 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 FOPEN_MAX" />
778 <MemberType>Field</MemberType>
780 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
781 <AssemblyVersion>2.0.0.0</AssemblyVersion>
782 <AssemblyVersion>4.0.0.0</AssemblyVersion>
786 <AttributeName>System.CLSCompliant(false)</AttributeName>
790 <ReturnType>System.Int32</ReturnType>
792 <MemberValue>16</MemberValue>
794 <summary>Maximum number of <c>FILE</c> pointer that may be open at one time.</summary>
795 <remarks>To be added.</remarks>
798 <Member MemberName="fprintf">
799 <MemberSignature Language="C#" Value="public static int fprintf (IntPtr stream, string message);" />
800 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 fprintf(native int stream, string message) cil managed" />
801 <MemberType>Method</MemberType>
803 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
804 <AssemblyVersion>2.0.0.0</AssemblyVersion>
805 <AssemblyVersion>4.0.0.0</AssemblyVersion>
808 <ReturnType>System.Int32</ReturnType>
811 <Parameter Name="stream" Type="System.IntPtr" />
812 <Parameter Name="message" Type="System.String" />
815 <param name="stream">
816 <c>FILE</c> stream to write to.</param>
817 <param name="message">The string to write on <paramref name="stream" />.</param>
818 <summary>Print to a <c>FILE</c> stream.</summary>
819 <returns>Returns the number of characters printed or a negative value if an error occurs, and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.
821 <block subset="none" type="usage"><para>The following errors are specified:
822 </para><list type="table"><listheader><term>Error</term><description>Details</description></listheader><item><term><see cref="F:Mono.Unix.Native.Errno.EILSEQ" /></term><description>An invalid wide character code was encountered</description></item><item><term><see cref="F:Mono.Unix.Native.Errno.ENOMEM" /></term><description>Insufficient storage space is available.</description></item></list><para>Any of the errors documented for the <see cref="M:Mono.Unix.Native.Syscall.write" /> system call may also be returned.
823 </para></block></returns>
827 <Member MemberName="fprintf">
828 <MemberSignature Language="C#" Value="public static int fprintf (IntPtr stream, string format, object[] parameters);" />
829 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 fprintf(native int stream, string format, object[] parameters) cil managed" />
830 <MemberType>Method</MemberType>
832 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
833 <AssemblyVersion>2.0.0.0</AssemblyVersion>
834 <AssemblyVersion>4.0.0.0</AssemblyVersion>
838 <AttributeName>System.Obsolete("Not necessarily portable due to cdecl restrictions.
839 Use fprintf (IntPtr, string) instead.")</AttributeName>
843 <ReturnType>System.Int32</ReturnType>
846 <Parameter Name="stream" Type="System.IntPtr" />
847 <Parameter Name="format" Type="System.String" />
848 <Parameter Name="parameters" Type="System.Object[]">
851 <AttributeName>System.ParamArray</AttributeName>
857 <param name="stream">
858 <c>FILE</c> stream to write to.</param>
859 <param name="format">The message format.</param>
860 <param name="parameters">Arguments to the message format.</param>
861 <summary>Print to a <c>FILE</c> stream.</summary>
862 <returns>Returns the number of characters printed or a negative value if an error occurs, and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.
864 <block subset="none" type="usage"><para>The following errors are specified:
865 </para><list type="table"><listheader><term>Error</term><description>Details</description></listheader><item><term><see cref="F:Mono.Unix.Native.Errno.EILSEQ" /></term><description>An invalid wide character code was encountered</description></item><item><term><see cref="F:Mono.Unix.Native.Errno.ENOMEM" /></term><description>Insufficient storage space is available.</description></item></list><para>Any of the errors documented for the <see cref="M:Mono.Unix.Native.Syscall.write" /> system call may also be returned.
866 </para></block></returns>
868 <para>The <c>fprintf</c>() family of functions produces output according to a format as described below. <c>fprintf</c>() writes output to the given output <paramref name="stream" />.</para>
869 <para>These functions write the output under the control of a <paramref name="format" /> string that specifies how subsequent arguments (or arguments accessed via the variable-length argument facilities of <c>stdarg</c>(3)) are converted for output.
871 <para>The format string is composed of zero or more directives: ordinary characters (not %), which are copied unchanged to the output stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments. Each conversion specification is introduced by the % character. The arguments must correspond properly (after type promotion) with the conversion specifier. After the %, the following appear in sequence:</para>
874 <term>An optional field, consisting of a decimal digit string followed by a <c>$</c>, specifying the next argument to access. If this field is not provided, the argument following the last argument accessed will be used. Arguments are numbered starting at <c>1</c>. If unaccessed arguments in the format string are interspersed with ones that are accessed the results will be indeterminate.</term>
877 <term>Zero or more of the following flags:
879 <list type="table"><listheader><term>Flag</term><description>Description</description></listheader><item><term>'<c>#</c>'</term><description>The value should be converted to an "alternate form". For <c>c</c>, <c>d</c>, <c>i</c>, <c>n</c>, <c>p</c>, <c>s</c>, and <c>u</c> conversions, this option has no effect. For <c>o</c> conversions, the precision of the number is increased to force the first character of the output string to a zero (except if a zero value is printed with an explicit precision of zero). For <c>x</c> and <c>X</c> conversions, a non-zero result has the string '<c>0x</c>' (or '<c>0X</c>' for <c>X</c> conversions) prepended to it. For <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, and <c>G</c> conversions, the result will always contain a decimal point, even if no digits follow it (normally, a decimal point appears in the results of those conversions only if a digit follows). For <c>g</c> and <c>G</c> conversions, trailing zeros are not removed from the result as they would otherwise be.</description></item><item><term>'<c>0</c>' (zero)</term><description>Zero padding. For all conversions except <c>n</c>, the converted value is padded on the left with zeros rather than blanks. If a precision is given with a numeric conversion (<c>d</c>, <c>i</c>, <c>o</c>, <c>u</c>, <c>i</c>, <c>x</c>, and <c>X</c>), the 0 flag is ignored.</description></item><item><term>'<c>-</c>'</term><description>A negative field width flag; the converted value is to be left adjusted on the field boundary. Except for <c>n</c> conversions, the converted value is padded on the right with blanks, rather than on the left with blanks or zeros. A <c>-</c> overrides a <c>0</c> if both are given.</description></item><item><term>'<c />' (space)</term><description>A blank should be left before a positive number produced by a signed conversion (<c>a</c>, <c>A</c>, <c>d</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, <c>G</c>, or <c>i</c>).</description></item><item><term>'<c>+</c>'</term><description>A sign must always be placed before a number produced by a signed conversion. A <c>+</c> overrides a space if both are used.</description></item><item><term>'<c>'</c>'</term><description>Decimal conversions (<c>d</c>, <c>u</c>, or <c>i</c>) or the integral portion of a floating point conversion (<c>f</c> or <c>F</c>) should be grouped and separated by thousands using the non-monetary separator returned by <see cref="M:Mono.Unix.Native.Syscall.localeconv" />(3).</description></item></list></term>
882 <term>An optional decimal digit string specifying a minimum field width. If the converted value has fewer characters than the field width, it will be padded with spaces on the left (or right, if the left-adjustment flag has been given) to fill out the field width.</term>
885 <term>An optional precision, in the form of a period . followed by an optional digit string. If the digit string is omitted, the precision is taken as zero. This gives the minimum number of digits to appear for <c>d</c>, <c>i</c>, <c>o</c>, <c>u</c>, <c>x</c>, and <c>X</c> conversions, the number of digits to appear after the decimal-point for <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, and <c>F</c> conversions, the maximum number of significant digits for <c>g</c> and <c>G</c> conversions, or the maximum number of characters to be printed from a string for <c>s</c> conversions.</term>
888 <term>An optional length modifier, that specifies the size of the argument. The following length modifiers are valid for the <c>d</c>, <c>i</c>, <c>n</c>, <c>o</c>, <c>u</c>, <c>x</c>, or <c>X</c> conversion:
890 <list type="table"><listheader><term>Modifier</term><description><c>d</c>, <c>i</c></description><description><c>o, u, x, X</c></description><description><c>n</c></description></listheader><item><term><c>hh</c></term><description><c>signed char</c></description><description><c>unsigned char</c></description><description><c>signed char *</c></description></item><item><term><c>h</c></term><description><c>short</c></description><description><c>unsigned short</c></description><description><c>short *</c></description></item><item><term><c>l</c> (ell)</term><description><c>long</c></description><description><c>unsigned long</c></description><description><c>unsigned long *</c></description></item><item><term><c>ll</c> (ell ell)</term><description><c>long long</c></description><description><c>unsigned long long</c></description><description><c>long long *</c></description></item><item><term><c>j</c></term><description><c>intmax_t</c></description><description><c>uintmax_t</c></description><description><c>intmax_t *</c></description></item><item><term><c>t</c></term><description><c>ptrdiff_t</c></description><description>(see note)</description><description><c>ptrdiff_t *</c></description></item><item><term><c>z</c></term><description>(see note)</description><description><c>size_t</c></description><description>(see note)</description></item><item><term><c>q</c><i>(deprecated)</i></term><description><c>quad_t</c></description><description><c>u_quad_t</c></description><description><c>quad_t *</c></description></item></list><block subset="none" type="note"><para>the <c>t</c> modifier, when applied to a <c>o</c>, <c>u</c>, <c>x</c>, or <c>X</c> conversion, indicates that the argument is of an unsigned type equivalent in size to a <c>ptrdiff_t</c>. The <c>z</c> modifier, when applied to a <c>d</c> or <c>i</c> conversion, indicates that the argument is of a signed type equivalent in size to a <c>size_t</c>. Similarly, when applied to an <c>n</c> conversion, it indicates that the argument is a pointer to a signed type equivalent in size to a <c>size_t</c>.
891 </para></block><para>The following length modifier is valid for the <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, or <c>G</c> conversion:</para><list type="table"><listheader><term>Modifier</term><description><c>a, A, e, E, f, F, g, G</c></description></listheader><item><term><c>L</c></term><description><c>long double</c></description></item></list><para>The following length modifier is valid for the <c>c</c> or <c>s</c> conversion:</para><list type="table"><listheader><term>Modifier</term><description><c>c</c></description><description><c>s</c></description></listheader><item><term><c>l</c> (ell)</term><description><c>wint_t</c></description><description><c>wchar_t *</c></description></item></list></term>
894 <term>A character that specifies the type of conversion to be applied.</term>
897 <para>A field width or precision, or both, may be indicated by an asterisk '<c>*</c>' or an asterisk followed by one or more decimal digits and a '<c>$</c>' instead of a digit string. In this case, an <i>int</i> argument supplies the field width or precision. A negative field width is treated as a left adjustment flag followed by a positive field width; a negative precision is treated as though it were missing. If a single format directive mixes positional (<c>nn$</c>) and non-positional arguments, the results are undefined
899 <para>The conversion specifiers and their meanings are:</para>
902 <term>Specifier</term>
903 <description>Meaning</description>
909 <description>The <c>int</c> (or appropriate variant) argument is converted to signed decimal (<c>d</c> and <c>i</c>), unsigned octal (<c>o</c>), unsigned decimal (<c>u</c>), or unsigned hexadecimal (<c>x</c> and <c>X</c>) notation. The letters "<c>abcdef</c>" are used for <c>x</c> conversions; the letters "<c>ABCDEF</c>" are used for <c>X</c> conversions. The precision, if any, gives the minimum number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with zeros.</description>
915 <description>The <c>long int</c> argument is converted to signed decimal, unsigned octal, or unsigned decimal, as if the format had been <c>ld</c>, <c>lo</c>, or <c>lu</c> respectively. These conversion characters are deprecated, and will eventually disappear.</description>
921 <description>The <c>double</c> argument is rounded and converted in the style <c>[-]d.ddde±dd</c> where there is one digit before the decimal-point character and the number of digits after it is equal to the precision; if the precision is missing, it is taken as 6; if the precision is zero, no decimal-point character appears. An <c>E</c> conversion uses the letter '<c>E</c>' (rather than '<c>e</c>') to introduce the exponent. The exponent always contains at least two digits; if the value is zero, the exponent is 00.</description>
922 <para>For <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, and <c>G</c> conversions, positive and negative infinity are represented as <c>inf</c> and <c>-inf</c> respectively when using the lowercase conversion character, and <c>INF</c> and <c>-INF</c> respectively when using the uppercase conversion character. Similarly, <c>NaN</c> is represented as <c>nan</c> when using the lowercase conversion, and <c>NAN</c> when using the uppercase conversion.</para>
928 <description>The <c>double</c> argument is rounded and converted to decimal notation in the style <c>[-]ddd.ddd</c>, where the number of digits after the decimal-point character is equal to the precision specification. If the precision is missing, it is taken as 6; if the precision is explicitly zero, no decimal-point character appears. If a decimal point appears, at least one digit appears before it.</description>
934 <description>The <c>double</c> argument is converted in style <c>f</c> or <c>e</c> (or <c>F</c> or <c>E</c> for <c>G</c> conversions). The precision specifies the number of significant digits. If the precision is missing, 6 digits are given; if the precision is zero, it is treated as 1. Style <c>e</c> is used if the exponent from its conversion is less than -4 or greater than or equal to the precision. Trailing zeros are removed from the fractional part of the result; a decimal point appears only if it is followed by at least one digit.</description>
940 <description>The <c>double</c> argument is rounded and converted to hexadecimal notation in the style <c>[-]0xh.hhhp[±]d</c>, where the number of digits after the hexadecimal-point character is equal to the precision specification. If the precision is missing, it is taken as enough to represent the floating-point number exactly, and no rounding occurs. If the precision is zero, no hexadecimal-point character appears. The <c>p</c> is a literal character '<c>p</c>', and the exponent consists of a positive or negative sign followed by a decimal number representing an exponent of 2. The <c>A</c> conversion uses the prefix "<c>0X</c>" (rather than "<c>0x</c>"), the letters "<c>ABCDEF</c>" (rather than "<c>abcdef</c>") to represent the hex digits, and the letter '<c>P</c>' (rather than '<c>p</c>') to separate the mantissa and exponent.
942 <para>Note that there may be multiple valid ways to represent floating-point numbers in this hexadecimal format. For example, <c>0x3.24p+0</c>, <c>0x6.48p-1</c> and <c>0xc.9p-2</c> are all equivalent. The format chosen depends on the internal representation of the number, but the implementation guarantees that the length of the mantissa will be minimized. Zeroes are always represented with a mantissa of 0 (preceded by a '<c>-</c>' if appropriate) and an exponent of +0.
943 </para></description>
949 <description>Treated as <c>c</c> with the <c>l</c> (ell) modifier.</description>
955 <description>The <c>int</c> argument is converted to an <c>unsigned char</c>, and the resulting character is written.
957 <para>If the <c>l</c> (ell) modifier is used, the <c>wint_t</c> argument shall be converted to a <c>wchar_t</c>, and the (potentially multi-byte) sequence representing the single wide character is written, including any shift sequences. If a shift sequence is used, the shift state is also restored to the original state after the character.
958 </para></description>
964 <description>Treated as <c>s</c> with the <c>l</c> (ell) modifier.</description>
971 The <c>char *</c> argument is expected to be a pointer to an array of character type (pointer to a string). Characters from the array are written up to (but not including) a terminating NUL character; if a precision is specified, no more than the number specified are written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the size of the array, the array must contain a terminating NUL character.
973 <para>If the <c>l</c> (ell) modifier is used, the <c>wchar_t *</c> argument is expected to be a pointer to an array of wide characters (pointer to a wide string). For each wide character in the string, the (potentially multi-byte) sequence representing the wide character is written, including any shift sequences. If any shift sequence is used, the shift state is also restored to the original state after the string. Wide characters from the array are written up to (but not including) a terminating wide NUL character; if a precision is specified, no more than the number of bytes specified are written (including shift sequences). Partial characters are never written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the number of bytes required to render the multibyte representation of the string, the array must contain a terminating wide NUL character.</para></description>
979 <description>The <c>void *</c> pointer argument is printed in hexadecimal (as if by '<c>%#x</c>' or '<c>%#lx</c>').</description>
985 <description>The number of characters written so far is stored into the integer indicated by the <c>int *</c> (or variant) pointer argument. No argument is converted.</description>
991 <description> A '<c>%</c>' is written. No argument is converted. The complete conversion specification is '<c>%%</c>'.</description>
994 <para>The decimal point character is defined in the program's locale (category <c>LC_NUMERIC</c>)
996 <para>In no case does a non-existent or small field width cause truncation of a numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result.</para>
1000 <Member MemberName="fputc">
1001 <MemberSignature Language="C#" Value="public static int fputc (int c, IntPtr stream);" />
1002 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "fputc" cdecl lasterr)int32 fputc(int32 c, native int stream) cil managed" />
1003 <MemberType>Method</MemberType>
1005 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1006 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1007 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1010 <ReturnType>System.Int32</ReturnType>
1013 <Parameter Name="c" Type="System.Int32" />
1014 <Parameter Name="stream" Type="System.IntPtr" />
1017 <param name="c">The charater to write.</param>
1018 <param name="stream">The <c>FILE</c> stream to write to.</param>
1019 <summary>Output a character to a <c>FILE</c> stream.</summary>
1020 <returns>Returns the character written. If an error occurrs, the value <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> is returned.</returns>
1021 <remarks>The <c>fputc</c>() function writes the character <paramref name="c" /> (converted to an "unsigned char") to the output stream pointed to by <paramref name="stream" />.</remarks>
1024 <Member MemberName="fputs">
1025 <MemberSignature Language="C#" Value="public static int fputs (string s, IntPtr stream);" />
1026 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "fputs" cdecl lasterr)int32 fputs(string s, native int stream) cil managed" />
1027 <MemberType>Method</MemberType>
1029 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1030 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1031 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1034 <ReturnType>System.Int32</ReturnType>
1037 <Parameter Name="s" Type="System.String" />
1038 <Parameter Name="stream" Type="System.IntPtr" />
1041 <param name="s">The string to write.</param>
1042 <param name="stream">The <c>FILE</c> stream to write to.</param>
1043 <summary>Output a line to a <c>FILE</c> stream.</summary>
1045 <para>The <c>fputs</c> function returns <c>0</c> on success and <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> on error, and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
1046 <block subset="none" type="usage">
1047 <para>The following errors are specified:</para>
1051 <description>Details</description>
1055 <see cref="F:Mono.Unix.Native.Errno.EBADF" />
1057 <description>The <paramref name="stream" /> argument not a writable stream.</description>
1062 <c>fputs</c> may also fail for any of the errors specified for the routines <see cref="M:Mono.Unix.Native.Syscall.write" />(2).
1065 <remarks> The function <c>fputs</c>() writes the string pointed to by <paramref name="s" /> to the stream pointed to by <paramref name="stream" />.</remarks>
1068 <Member MemberName="fread">
1069 <MemberSignature Language="C#" Value="public static ulong fread (byte[] ptr, IntPtr stream);" />
1070 <MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int64 fread(unsigned int8[] ptr, native int stream) cil managed" />
1071 <MemberType>Method</MemberType>
1073 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1074 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1075 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1079 <AttributeName>System.CLSCompliant(false)</AttributeName>
1083 <ReturnType>System.UInt64</ReturnType>
1086 <Parameter Name="ptr" Type="System.Byte[]" />
1087 <Parameter Name="stream" Type="System.IntPtr" />
1090 <param name="ptr">Where to store the binary data read.</param>
1091 <param name="stream">The binary <c>FILE</c> stream to read from.</param>
1092 <summary>Read from a binary stream.</summary>
1094 <para>The function <c>fread</c>() advances the file position indicator for the stream by the number of bytes read. It returns the number of objects read or written. If an error occurs, or the end-of-file is reached, the return value is a short object count (or zero).</para>
1095 <para>The function <c>fread</c>() does not distinguish between end-of-file and error, and callers must use <see cref="M:Mono.Unix.Native.Stdlib.feof" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ferror" />(3) to determine which occurred.</para>
1097 <remarks>The function <c>fread</c>() reads <c><paramref name="ptr" />.Length</c> bytes from the stream pointed to by <paramref name="stream" />, storing them at the location given by <paramref name="ptr" />.</remarks>
1100 <Member MemberName="fread">
1101 <MemberSignature Language="C#" Value="public static ulong fread (byte[] ptr, ulong size, ulong nmemb, IntPtr stream);" />
1102 <MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int64 fread(unsigned int8[] ptr, unsigned int64 size, unsigned int64 nmemb, native int stream) cil managed" />
1103 <MemberType>Method</MemberType>
1105 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1106 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1107 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1111 <AttributeName>System.CLSCompliant(false)</AttributeName>
1115 <ReturnType>System.UInt64</ReturnType>
1118 <Parameter Name="ptr" Type="System.Byte[]" />
1119 <Parameter Name="size" Type="System.UInt64" />
1120 <Parameter Name="nmemb" Type="System.UInt64" />
1121 <Parameter Name="stream" Type="System.IntPtr" />
1124 <param name="ptr">Where to store the binary data read.</param>
1125 <param name="size">The size of each object to read.</param>
1126 <param name="nmemb">The number of objects to read.</param>
1127 <param name="stream">The binary <c>FILE</c> stream to read from.</param>
1128 <summary>Read from a binary stream.</summary>
1130 <para>The function <c>fread</c>() advances the file position indicator for the stream by the number of bytes read. It returns the number of objects read or written. If an error occurs, or the end-of-file is reached, the return value is a short object count (or zero).</para>
1131 <para>The function <c>fread</c>() does not distinguish between end-of-file and error, and callers must use <see cref="M:Mono.Unix.Native.Stdlib.feof" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ferror" />(3) to determine which occurred.</para>
1133 <remarks>The function <c>fread</c>() reads <paramref name="nmemb" /> objects, each <paramref name="size" /> bytes long, from the stream pointed to by <paramref name="stream" />, storing them at the location given by <paramref name="ptr" />.</remarks>
1136 <Member MemberName="fread">
1137 <MemberSignature Language="C#" Value="public static ulong fread (IntPtr ptr, ulong size, ulong nmemb, IntPtr stream);" />
1138 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_fread" cdecl lasterr)unsigned int64 fread(native int ptr, unsigned int64 size, unsigned int64 nmemb, native int stream) cil managed" />
1139 <MemberType>Method</MemberType>
1141 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1142 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1143 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1147 <AttributeName>System.CLSCompliant(false)</AttributeName>
1151 <ReturnType>System.UInt64</ReturnType>
1154 <Parameter Name="ptr" Type="System.IntPtr" />
1155 <Parameter Name="size" Type="System.UInt64" />
1156 <Parameter Name="nmemb" Type="System.UInt64" />
1157 <Parameter Name="stream" Type="System.IntPtr" />
1160 <param name="ptr">Where to store the binary data read.</param>
1161 <param name="size">The size of each object to read.</param>
1162 <param name="nmemb">The number of objects to read.</param>
1163 <param name="stream">The binary <c>FILE</c> stream to read from.</param>
1164 <summary>Read from a binary stream.</summary>
1166 <para>The function <c>fread</c>() advances the file position indicator for the stream by the number of bytes read. It returns the number of objects read or written. If an error occurs, or the end-of-file is reached, the return value is a short object count (or zero).</para>
1167 <para>The function <c>fread</c>() does not distinguish between end-of-file and error, and callers must use <see cref="M:Mono.Unix.Native.Stdlib.feof" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ferror" />(3) to determine which occurred.</para>
1169 <remarks>The function <c>fread</c>() reads <paramref name="nmemb" /> objects, each <paramref name="size" /> bytes long, from the stream pointed to by <paramref name="stream" />, storing them at the location given by <paramref name="ptr" />.</remarks>
1172 <Member MemberName="fread">
1173 <MemberSignature Language="C#" Value="public static ulong fread (void* ptr, ulong size, ulong nmemb, IntPtr stream);" />
1174 <MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int64 fread(void* ptr, unsigned int64 size, unsigned int64 nmemb, native int stream) cil managed" />
1175 <MemberType>Method</MemberType>
1177 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1178 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1179 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1183 <AttributeName>System.CLSCompliant(false)</AttributeName>
1187 <ReturnType>System.UInt64</ReturnType>
1190 <Parameter Name="ptr" Type="System.Void*" />
1191 <Parameter Name="size" Type="System.UInt64" />
1192 <Parameter Name="nmemb" Type="System.UInt64" />
1193 <Parameter Name="stream" Type="System.IntPtr" />
1196 <param name="ptr">Where to store the binary data read.</param>
1197 <param name="size">The size of each object to read.</param>
1198 <param name="nmemb">The number of objects to read.</param>
1199 <param name="stream">The binary <c>FILE</c> stream to read from.</param>
1200 <summary>Read from a binary stream.</summary>
1202 <para>The function <c>fread</c>() advances the file position indicator for the stream by the number of bytes read. It returns the number of objects read or written. If an error occurs, or the end-of-file is reached, the return value is a short object count (or zero).</para>
1203 <para>The function <c>fread</c>() does not distinguish between end-of-file and error, and callers must use <see cref="M:Mono.Unix.Native.Stdlib.feof" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ferror" />(3) to determine which occurred.</para>
1205 <remarks>The function <c>fread</c>() reads <paramref name="nmemb" /> objects, each <paramref name="size" /> bytes long, from the stream pointed to by <paramref name="stream" />, storing them at the location given by <paramref name="ptr" />.</remarks>
1208 <Member MemberName="free">
1209 <MemberSignature Language="C#" Value="public static void free (IntPtr ptr);" />
1210 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "free" cdecl)void free(native int ptr) cil managed" />
1211 <MemberType>Method</MemberType>
1213 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1214 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1215 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1218 <ReturnType>System.Void</ReturnType>
1221 <Parameter Name="ptr" Type="System.IntPtr" />
1224 <param name="ptr">The start of a memory area to free.</param>
1225 <summary>Free allocated memory.</summary>
1226 <remarks>The <c>free</c>() function causes the allocated memory referenced by <paramref name="ptr" /> to be made available for future allocations. If <paramref name="ptr" /> is <see cref="F:System.IntPtr.Zero" />, no action occurs.</remarks>
1229 <Member MemberName="freopen">
1230 <MemberSignature Language="C#" Value="public static IntPtr freopen (string path, string mode, IntPtr stream);" />
1231 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "freopen" cdecl lasterr)native int freopen(string path, string mode, native int stream) cil managed" />
1232 <MemberType>Method</MemberType>
1234 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1235 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1236 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1239 <ReturnType>System.IntPtr</ReturnType>
1242 <Parameter Name="path" Type="System.String" />
1243 <Parameter Name="mode" Type="System.String" />
1244 <Parameter Name="stream" Type="System.IntPtr" />
1247 <param name="path">The filename to open.</param>
1248 <param name="mode">The file mode for opening. See the Remarks section for more details.</param>
1249 <param name="stream">The <c>FILE</c> stream to reopen.</param>
1250 <summary>Reopen a <c>FILE</c> stream.</summary>
1252 <para>Upon successful completion, returns a <c>FILE</c> pointer. Otherwise, <see cref="F:System.IntPtr.Zero" /> is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
1253 <block subset="none" type="usage">
1254 <para>The following errors are specified:</para>
1258 <description>Details</description>
1262 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
1264 <description>The <paramref name="mode" /> argument was invalid.</description>
1269 <c>freopen</c> may also fail for any of the error specified for the routines <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3),
1270 <see cref="M:Mono.Unix.Native.Syscall.open" />(2),
1271 <see cref="M:Mono.Unix.Native.Stdlib.fclose" />(3), and
1272 <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3).
1276 <para>The <c>freopen</c>() function opens the file whose name is the string pointed to by <paramref name="path" /> and associates the stream pointed to by <paramref name="stream" /> with it. The original stream (if it exists) is closed.
1278 <para>Use <see cref="M:Mono.Unix.Native.Stdlib.fclose" /> to close the returned <c>FILE</c> stream.</para>
1279 <para>The argument <paramref name="mode" /> points to a string beginning with one of the following sequences (Additional characters may follow these sequences.):
1284 <paramref name="mode" />
1286 <description>Description</description>
1292 <description> Open text file for reading. The stream is positioned at the beginning of the file.</description>
1298 <description>Open for reading and writing. The stream is positioned at the beginning of the file.</description>
1304 <description>Truncate file to zero length or create text file for writing. The stream is positioned at the beginning of the file.</description>
1310 <description>Open for reading and writing. The file is created if it does not exist, otherwise it is truncated. The stream is positioned at the beginning of the file.</description>
1316 <description>Open for writing. The file is created if it does not exist. The stream is positioned at the end of the file. Subsequent writes to the file will always end up at the then current end of file, irrespective of any intervening <see cref="M:Mono.Unix.Native.Stdlib.fseek" />(3) or similar.</description>
1322 <description>Open for reading and writing. The file is created if it does not exist. The stream is positioned at the end of the file. Subsequent writes to the file will always end up at the then current end of file, irrespective of any intervening <see cref="M:Mono.Unix.Native.Stdlib.fseek" />(3) or similar.</description>
1325 <para>The <paramref name="mode" /> string can also include the letter "b" either as a third character or as a character between the characters in any of the two-character strings described above, and is used to enable <i>binary</i> reading/writing on platforms which have different text/binary encodings (read: Microsoft Windows). The default (non-<c>b</c><paramref name="mode" />) is text encoding.</para>
1326 <para>If the <paramref name="path" /> argument is <see langword="null" />, <c>freopen</c>() attempts to re-open the file associated with <paramref name="stream" /> with a new mode. The new mode must be compatible with the mode that the stream was originally opened with:
1328 <list type="bullet">
1330 <term>Streams originally opened with mode <c>"r"</c> can only be reopened with that same mode.</term>
1333 <term>Streams originally opened with mode <c>"a"</c> can be reopened with the same mode, or mode <c>"w"</c>.</term>
1336 <term>Streams originally opened with mode <c>"w"</c> can be reopened with the same mode, or mode <c>"a"</c>.</term>
1339 <term>Streams originally opened with mode <c>"r+"</c>, <c>"w+"</c>, or <c>"a+"</c> can be reopened with any mode.</term>
1342 <para>The primary use of the <c>freopen</c>() function is to change the file associated with a standard text stream (<see cref="F:Mono.Unix.Native.Stdlib.stderr" />, <see cref="F:Mono.Unix.Native.Stdlib.stdin" />, or <see cref="F:Mono.Unix.Native.Stdlib.stdout" />).
1347 <Member MemberName="fseek">
1348 <MemberSignature Language="C#" Value="public static int fseek (IntPtr stream, long offset, Mono.Unix.Native.SeekFlags origin);" />
1349 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 fseek(native int stream, int64 offset, valuetype Mono.Unix.Native.SeekFlags origin) cil managed" />
1350 <MemberType>Method</MemberType>
1352 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1353 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1354 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1358 <AttributeName>System.CLSCompliant(false)</AttributeName>
1362 <ReturnType>System.Int32</ReturnType>
1365 <Parameter Name="stream" Type="System.IntPtr" />
1366 <Parameter Name="offset" Type="System.Int64" />
1367 <Parameter Name="origin" Type="Mono.Unix.Native.SeekFlags" />
1370 <param name="stream">
1371 <c>FILE</c> stream to seek.</param>
1372 <param name="offset">Number of bytes to add to the the file offset specified by <paramref name="whence" />.</param>
1373 <param name="origin">File offset to add <paramref name="offset" /> to.</param>
1374 <summary>Set file position for a <c>FILE</c> stream.</summary>
1376 <para>Returns <c>0</c> if successful; otherwise <c>-1</c> is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
1377 <block subset="none" type="usage">
1378 <para>The following errors are specified:</para>
1382 <description>Details</description>
1386 <see cref="F:Mono.Unix.Native.Errno.EBADF" />
1388 <description>The <paramref name="stream" /> argument is not not a seekable stream</description>
1392 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
1394 <description>The <paramref name="whence" /> argument is invalid or the resulting file-position indicator would be set to a negative value.</description>
1398 <see cref="F:Mono.Unix.Native.Errno.EOVERFLOW" />
1400 <description>The resulting file offset would be a value which cannot be represented correctly in an object of type <see cref="System.Int64" /> for <see cref="M:Mono.Unix.Native.Stdlib.fseek" />() and <see cref="M:Mono.Unix.Native.Stdlib.ftell" />().</description>
1404 <see cref="F:Mono.Unix.Native.Errno.ESPIPE" />
1406 <description>The file descriptor underlying stream is associated with a pipe or FIFO or file-position indicator value is unspecified (see <see cref="M:Mono.Unix.Native.Stdlib.ungetc" />(3)).</description>
1411 <c>fseek</c> may also fail for any of the error specified for the routines <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3), <see cref="M:Mono.Unix.Native.Syscall.fstat" />(2), <see cref="M:Mono.Unix.Native.Syscall.lseek" />(2), and <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3)
1414 <remarks>The <c>fseek</c>() function sets the file position indicator for the stream pointed to by <paramref name="stream" />. The new position, measured in bytes, is obtained by adding <paramref name="offset" /> bytes to the position specified by <paramref name="whence" />. If whence is set to <see cref="F:Mono.Unix.Native.SeekFlags.SEEK_SET" />, <see cref="F:Mono.Unix.Native.SeekFlags.SEEK_CUR" />, or <see cref="F:Mono.Unix.Native.SeekFlags.SEEK_END" />, the offset is relative to the start of the file, the current position indicator, or end-of-file, respectively. A successful call to the <c>fseek</c>() function clears the end-of-file indicator for the stream and undoes any effects of the <see cref="M:Mono.Unix.Native.Stdlib.ungetc" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ungetwc" />(3) functions on the same stream.</remarks>
1417 <Member MemberName="fsetpos">
1418 <MemberSignature Language="C#" Value="public static int fsetpos (IntPtr stream, Mono.Unix.Native.FilePosition pos);" />
1419 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 fsetpos(native int stream, class Mono.Unix.Native.FilePosition pos) cil managed" />
1420 <MemberType>Method</MemberType>
1422 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1423 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1424 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1427 <ReturnType>System.Int32</ReturnType>
1430 <Parameter Name="stream" Type="System.IntPtr" />
1431 <Parameter Name="pos" Type="Mono.Unix.Native.FilePosition" />
1434 <param name="stream">
1435 <c>FILE</c> stream to set the current file position for.</param>
1436 <param name="pos">The file position to seek to.</param>
1437 <summary>Sets the current file position of a <c>FILE</c> stream.</summary>
1439 <para>Returns <c>0</c> if successful; otherwise <c>-1</c> is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
1440 <block subset="none" type="usage">
1441 <para>The following errors are specified:</para>
1445 <description>Details</description>
1449 <see cref="F:Mono.Unix.Native.Errno.EBADF" />
1451 <description>The <paramref name="stream" /> argument is not not a seekable stream</description>
1455 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
1457 <description>The <paramref name="whence" /> argument is invalid or the resulting file-position indicator would be set to a negative value.</description>
1461 <see cref="F:Mono.Unix.Native.Errno.EOVERFLOW" />
1463 <description>The resulting file offset would be a value which cannot be represented correctly in an object of type <see cref="System.Int64" /> for <see cref="M:Mono.Unix.Native.Stdlib.fseek" />() and <see cref="M:Mono.Unix.Native.Stdlib.ftell" />().</description>
1467 <see cref="F:Mono.Unix.Native.Errno.ESPIPE" />
1469 <description>The file descriptor underlying stream is associated with a pipe or FIFO or file-position indicator value is unspecified (see <see cref="M:Mono.Unix.Native.Stdlib.ungetc" />(3)).</description>
1474 <c>fsetpos</c> may also fail for any of the error specified for the routines <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3), <see cref="M:Mono.Unix.Native.Syscall.fstat" />(2), <see cref="M:Mono.Unix.Native.Syscall.lseek" />(2), and <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3)
1477 <remarks>The <c>fsetpos</c>() function is an alternate interfaces for setting the current position in the file, similar to <see cref="M:Mono.Unix.Native.Stdlib.fseek" />(), except that the current position is stored in an opaque object of type <see cref="T:Mono.Unix.Native.FilePosition" /> pointed to by pos. This provides a portable way to seek to offsets larger than those that can be represented by a long int. It may also store additional state information in the <see cref="T:Mono.Unix.Native.FilePosition" /> object to facilitate seeking within files containing multibyte characters with state-dependent encodings.
1481 <Member MemberName="ftell">
1482 <MemberSignature Language="C#" Value="public static long ftell (IntPtr stream);" />
1483 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_ftell" cdecl lasterr)int64 ftell(native int stream) cil managed" />
1484 <MemberType>Method</MemberType>
1486 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1487 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1488 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1491 <ReturnType>System.Int64</ReturnType>
1494 <Parameter Name="stream" Type="System.IntPtr" />
1497 <param name="stream">
1498 <c>FILE</c> stream to get the file position from.</param>
1499 <summary>Get current file position for <c>FILE</c> stream.</summary>
1501 <para>Returns the current file offset if successful; otherwise <c>-1</c> is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
1502 <block subset="none" type="usage">
1503 <para>The following errors are specified:</para>
1507 <description>Details</description>
1511 <see cref="F:Mono.Unix.Native.Errno.EBADF" />
1513 <description>The <paramref name="stream" /> argument is not not a seekable stream</description>
1517 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
1519 <description>The <paramref name="whence" /> argument is invalid or the resulting file-position indicator would be set to a negative value.</description>
1523 <see cref="F:Mono.Unix.Native.Errno.EOVERFLOW" />
1525 <description>The resulting file offset would be a value which cannot be represented correctly in an object of type <see cref="System.Int64" /> for <see cref="M:Mono.Unix.Native.Stdlib.fseek" />() and <see cref="M:Mono.Unix.Native.Stdlib.ftell" />().</description>
1529 <see cref="F:Mono.Unix.Native.Errno.ESPIPE" />
1531 <description>The file descriptor underlying stream is associated with a pipe or FIFO or file-position indicator value is unspecified (see <see cref="M:Mono.Unix.Native.Stdlib.ungetc" />(3)).</description>
1536 <c>ftell</c> may also fail for any of the error specified for the routines <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3), <see cref="M:Mono.Unix.Native.Syscall.fstat" />(2), <see cref="M:Mono.Unix.Native.Syscall.lseek" />(2), and <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3)
1539 <remarks>The <c>ftell</c>() function obtains the current value of the file position indicator for the stream pointed to by <paramref name="stream" />.</remarks>
1542 <Member MemberName="fwrite">
1543 <MemberSignature Language="C#" Value="public static ulong fwrite (byte[] ptr, IntPtr stream);" />
1544 <MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int64 fwrite(unsigned int8[] ptr, native int stream) cil managed" />
1545 <MemberType>Method</MemberType>
1547 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1548 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1549 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1553 <AttributeName>System.CLSCompliant(false)</AttributeName>
1557 <ReturnType>System.UInt64</ReturnType>
1560 <Parameter Name="ptr" Type="System.Byte[]" />
1561 <Parameter Name="stream" Type="System.IntPtr" />
1564 <param name="ptr">The data to write.</param>
1565 <param name="stream">The binary <c>FILE</c> stream to write to.</param>
1566 <summary>Write to a binary <c>FILE</c> stream.</summary>
1568 <para>The function <c>fwrite</c>() advance the file position indicator for the stream by the number of bytes written. It returns the number of objects written. If an error occurs, or the end-of-file is reached, the return value is a short object count (or zero).</para>
1569 <para>The function <c>fwrite</c>() returns a value less than <paramref name="nmemb" /> only if a write error has occurred.
1573 <para>The function <c>fwrite</c>() writes <c><paramref name="ptr" />.Length</c> bytes to the stream pointed to by <paramref name="stream" />, obtaining them from the location given by <paramref name="ptr" />.
1578 <Member MemberName="fwrite">
1579 <MemberSignature Language="C#" Value="public static ulong fwrite (byte[] ptr, ulong size, ulong nmemb, IntPtr stream);" />
1580 <MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int64 fwrite(unsigned int8[] ptr, unsigned int64 size, unsigned int64 nmemb, native int stream) cil managed" />
1581 <MemberType>Method</MemberType>
1583 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1584 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1585 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1589 <AttributeName>System.CLSCompliant(false)</AttributeName>
1593 <ReturnType>System.UInt64</ReturnType>
1596 <Parameter Name="ptr" Type="System.Byte[]" />
1597 <Parameter Name="size" Type="System.UInt64" />
1598 <Parameter Name="nmemb" Type="System.UInt64" />
1599 <Parameter Name="stream" Type="System.IntPtr" />
1602 <param name="ptr">The data to write.</param>
1603 <param name="size">The size of each object to write.</param>
1604 <param name="nmemb">The number of objects to write.</param>
1605 <param name="stream">The binary <c>FILE</c> stream to write to.</param>
1606 <summary>Write to a binary <c>FILE</c> stream.</summary>
1608 <para>The function <c>fwrite</c>() advance the file position indicator for the stream by the number of bytes written. It returns the number of objects written. If an error occurs, or the end-of-file is reached, the return value is a short object count (or zero).</para>
1609 <para>The function <c>fwrite</c>() returns a value less than <paramref name="nmemb" /> only if a write error has occurred.
1613 <para>The function <c>fwrite</c>() writes <paramref name="nmemb" /> objects, each <paramref name="size" /> bytes long, to the stream pointed to by <paramref name="stream" />, obtaining them from the location given by <paramref name="ptr" />.
1618 <Member MemberName="fwrite">
1619 <MemberSignature Language="C#" Value="public static ulong fwrite (IntPtr ptr, ulong size, ulong nmemb, IntPtr stream);" />
1620 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_fwrite" cdecl lasterr)unsigned int64 fwrite(native int ptr, unsigned int64 size, unsigned int64 nmemb, native int stream) cil managed" />
1621 <MemberType>Method</MemberType>
1623 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1624 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1625 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1629 <AttributeName>System.CLSCompliant(false)</AttributeName>
1633 <ReturnType>System.UInt64</ReturnType>
1636 <Parameter Name="ptr" Type="System.IntPtr" />
1637 <Parameter Name="size" Type="System.UInt64" />
1638 <Parameter Name="nmemb" Type="System.UInt64" />
1639 <Parameter Name="stream" Type="System.IntPtr" />
1642 <param name="ptr">The data to write.</param>
1643 <param name="size">The size of each object to write.</param>
1644 <param name="nmemb">The number of objects to write.</param>
1645 <param name="stream">The binary <c>FILE</c> stream to write to.</param>
1646 <summary>Write to a binary <c>FILE</c> stream.</summary>
1648 <para>The function <c>fwrite</c>() advance the file position indicator for the stream by the number of bytes written. It returns the number of objects written. If an error occurs, or the end-of-file is reached, the return value is a short object count (or zero).</para>
1649 <para>The function <c>fwrite</c>() returns a value less than <paramref name="nmemb" /> only if a write error has occurred.
1653 <para>The function <c>fwrite</c>() writes <paramref name="nmemb" /> objects, each <paramref name="size" /> bytes long, to the stream pointed to by <paramref name="stream" />, obtaining them from the location given by <paramref name="ptr" />.
1658 <Member MemberName="fwrite">
1659 <MemberSignature Language="C#" Value="public static ulong fwrite (void* ptr, ulong size, ulong nmemb, IntPtr stream);" />
1660 <MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int64 fwrite(void* ptr, unsigned int64 size, unsigned int64 nmemb, native int stream) cil managed" />
1661 <MemberType>Method</MemberType>
1663 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1664 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1665 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1669 <AttributeName>System.CLSCompliant(false)</AttributeName>
1673 <ReturnType>System.UInt64</ReturnType>
1676 <Parameter Name="ptr" Type="System.Void*" />
1677 <Parameter Name="size" Type="System.UInt64" />
1678 <Parameter Name="nmemb" Type="System.UInt64" />
1679 <Parameter Name="stream" Type="System.IntPtr" />
1682 <param name="ptr">The data to write.</param>
1683 <param name="size">The size of each object to write.</param>
1684 <param name="nmemb">The number of objects to write.</param>
1685 <param name="stream">The binary <c>FILE</c> stream to write to.</param>
1686 <summary>Write to a binary <c>FILE</c> stream.</summary>
1688 <para>The function <c>fwrite</c>() advance the file position indicator for the stream by the number of bytes written. It returns the number of objects written. If an error occurs, or the end-of-file is reached, the return value is a short object count (or zero).</para>
1689 <para>The function <c>fwrite</c>() returns a value less than <paramref name="nmemb" /> only if a write error has occurred.
1693 <para>The function <c>fwrite</c>() writes <paramref name="nmemb" /> objects, each <paramref name="size" /> bytes long, to the stream pointed to by <paramref name="stream" />, obtaining them from the location given by <paramref name="ptr" />.
1698 <Member MemberName="getc">
1699 <MemberSignature Language="C#" Value="public static int getc (IntPtr stream);" />
1700 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "getc" cdecl lasterr)int32 getc(native int stream) cil managed" />
1701 <MemberType>Method</MemberType>
1703 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1704 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1705 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1708 <ReturnType>System.Int32</ReturnType>
1711 <Parameter Name="stream" Type="System.IntPtr" />
1714 <param name="stream">
1715 <c>FILE</c> stream to read a character from.</param>
1716 <summary>Get next character from a <c>FILE</c> input stream.</summary>
1717 <returns>If successful, returns the next requested object from the stream. Character values are returned as an unsigned char converted to an int. If the stream is at end-of-file or a read error occurs, the routines return <see cref="M:Mono.Unix.Native.Stdlib.EOF" />. The routines <see cref="M:Mono.Unix.Native.Stdlib.feof" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ferror" />(3) must be used to distinguish between end-of-file and error. If an error occurs, use <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error. The end-of-file condition is remembered, even on a terminal, and all subsequent attempts to read will return <see cref="M:Mono.Unix.Native.Stdlib.EOF" /> until the condition is cleared with <see cref="M:Mono.Unix.Native.Stdlib.clearerr" />(3).</returns>
1718 <remarks>The <c>getc</c>() function obtains the next input character (if present) from the stream pointed at by stream, or the next character pushed back on the stream via <see cref="M:Mono.Unix.Native.Stdlib.ungetc" />(3).</remarks>
1721 <Member MemberName="getchar">
1722 <MemberSignature Language="C#" Value="public static int getchar ();" />
1723 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "getchar" cdecl lasterr)int32 getchar() cil managed" />
1724 <MemberType>Method</MemberType>
1726 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1727 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1728 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1731 <ReturnType>System.Int32</ReturnType>
1735 <summary>Get next character from standard input.</summary>
1736 <returns>If successful, returns the next requested object from the stream. Character values are returned as an unsigned char converted to an int. If the stream is at end-of-file or a read error occurs, the routines return <see cref="M:Mono.Unix.Native.Stdlib.EOF" />. The routines <see cref="M:Mono.Unix.Native.Stdlib.feof" />(3) and <see cref="M:Mono.Unix.Native.Stdlib.ferror" />(3) must be used to distinguish between end-of-file and error. If an error occurs, use <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error. The end-of-file condition is remembered, even on a terminal, and all subsequent attempts to read will return <see cref="M:Mono.Unix.Native.Stdlib.EOF" /> until the condition is cleared with <see cref="M:Mono.Unix.Native.Stdlib.clearerr" />(3).</returns>
1737 <remarks>The <c>getchar</c>() function is equivalent to <c><see cref="M:Mono.Unix.Native.Stdlib.getc" /> (<see cref="F:Mono.Unix.Native.Stdlib.stdin" />)</c>,
1738 obtaining the next input character (if present) from <see cref="F:Mono.Unix.Native.Stdlib.stdin" />, or the next character pushed back on <c>stdin</c> via <see cref="M:Mono.Unix.Native.Stdlib.ungetc" />(3).</remarks>
1741 <Member MemberName="getenv">
1742 <MemberSignature Language="C#" Value="public static string getenv (string name);" />
1743 <MemberSignature Language="ILAsm" Value=".method public static hidebysig string getenv(string name) cil managed" />
1744 <MemberType>Method</MemberType>
1746 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1747 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1748 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1751 <ReturnType>System.String</ReturnType>
1754 <Parameter Name="name" Type="System.String" />
1757 <param name="name">The environment variable to read.</param>
1758 <summary>Read an environment variable.</summary>
1759 <returns>The <c>getenv</c>() function returns the value of the environment variable as a string. If the variable name is not in the current environment, <see langword="null" /> is returned.</returns>
1760 <remarks>The <c>getenv</c>() function obtains the current value of the environment variable, <paramref name="name" />.</remarks>
1763 <Member MemberName="GetLastError">
1764 <MemberSignature Language="C#" Value="public static Mono.Unix.Native.Errno GetLastError ();" />
1765 <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Mono.Unix.Native.Errno GetLastError() cil managed" />
1766 <MemberType>Method</MemberType>
1768 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1769 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1770 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1773 <ReturnType>Mono.Unix.Native.Errno</ReturnType>
1777 <summary>Reads and translates <c>errno</c>.</summary>
1778 <returns>To be added.</returns>
1779 <remarks>To be added.</remarks>
1782 <Member MemberName="L_tmpnam">
1783 <MemberSignature Language="C#" Value="public static readonly int L_tmpnam;" />
1784 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 L_tmpnam" />
1785 <MemberType>Field</MemberType>
1787 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1788 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1789 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1793 <AttributeName>System.CLSCompliant(false)</AttributeName>
1797 <ReturnType>System.Int32</ReturnType>
1799 <MemberValue>20</MemberValue>
1801 <summary>The number of characters filled by <see cref="M:Mono.Unix.Native.Stdlib.tmpnam" />(3).</summary>
1802 <remarks>To be added.</remarks>
1805 <Member MemberName="malloc">
1806 <MemberSignature Language="C#" Value="public static IntPtr malloc (ulong size);" />
1807 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_malloc" cdecl lasterr)native int malloc(unsigned int64 size) cil managed" />
1808 <MemberType>Method</MemberType>
1810 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1811 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1812 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1816 <AttributeName>System.CLSCompliant(false)</AttributeName>
1820 <ReturnType>System.IntPtr</ReturnType>
1823 <Parameter Name="size" Type="System.UInt64" />
1826 <param name="size">Amount of memory to allocate.</param>
1827 <summary>Allocate memory.</summary>
1828 <returns>The <c>malloc</c>() function returns a pointer to the allocated memory if successful; otherwise a <see cref="F:System.IntPtr.Zero" /> pointer is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> returns <see cref="F:Mono.Unix.Native.Errno.ENOMEM" />.</returns>
1830 <para>The <c>malloc</c>() function allocates <paramref name="size" /> bytes of memory. The allocated space is suitably aligned (after possible pointer coercion) for storage of any type of object. If the space is at least <paramref name="pagesize" /> bytes in length (see <see cref="M:Mono.Unix.Native.Syscall.getpagesize" />(3)), the returned memory will be page boundary aligned as well. If <c>malloc</c>() fails, <see cref="F:System.IntPtr.Zero" /> is returned.</para>
1831 <para>You should <see cref="M:Mono.Unix.Native.Stdlib.free" /> the return value to avoid a memory leak.</para>
1832 <para>Note that <c>malloc</c>() does NOT normally initialize the returned memory to zero bytes.
1837 <Member MemberName="MB_CUR_MAX">
1838 <MemberSignature Language="C#" Value="public static readonly int MB_CUR_MAX;" />
1839 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 MB_CUR_MAX" />
1840 <MemberType>Field</MemberType>
1842 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1843 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1844 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1848 <AttributeName>System.CLSCompliant(false)</AttributeName>
1852 <ReturnType>System.Int32</ReturnType>
1854 <MemberValue>6</MemberValue>
1856 <summary>To be added.</summary>
1857 <remarks>To be added.</remarks>
1860 <Member MemberName="perror">
1861 <MemberSignature Language="C#" Value="public static int perror (string s);" />
1862 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 perror(string s) cil managed" />
1863 <MemberType>Method</MemberType>
1865 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1866 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1867 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1870 <ReturnType>System.Int32</ReturnType>
1873 <Parameter Name="s" Type="System.String" />
1876 <param name="s">The error message prefix to print.</param>
1877 <summary>Print an error message to <see cref="F:Mono.Unix.Native.Stdlib.stderr" />.</summary>
1878 <returns>The <c>perror</c>() function returns the value 0 if successful; otherwise the value -1 is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</returns>
1879 <remarks>The <c>perror</c>() function finds the error message corresponding to the current value of <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> and writes it, followed by a newline, to the standard error file descriptor. If the argument string is not <see langword="null" /> and does not point to the null character, this string is prepended to the message string and separated from it by a colon and space ("<c>: </c>"); otherwise, only the error message string is printed.</remarks>
1882 <Member MemberName="printf">
1883 <MemberSignature Language="C#" Value="public static int printf (string message);" />
1884 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 printf(string message) cil managed" />
1885 <MemberType>Method</MemberType>
1887 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1888 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1889 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1892 <ReturnType>System.Int32</ReturnType>
1895 <Parameter Name="message" Type="System.String" />
1898 <param name="message">The message to print.</param>
1899 <summary>Prints a message on <see cref="F:Mono.Unix.Native.Stdlib.stdout" />.</summary>
1900 <returns>Returns the number of characters printed or a negative value if an error occurs, and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.
1902 <block subset="none" type="usage"><para>The following errors are specified:
1903 </para><list type="table"><listheader><term>Error</term><description>Details</description></listheader><item><term><see cref="F:Mono.Unix.Native.Errno.EILSEQ" /></term><description>An invalid wide character code was encountered</description></item><item><term><see cref="F:Mono.Unix.Native.Errno.ENOMEM" /></term><description>Insufficient storage space is available.</description></item></list><para>Any of the errors documented for the <see cref="M:Mono.Unix.Native.Syscall.write" /> system call may also be returned.
1904 </para></block></returns>
1908 <Member MemberName="printf">
1909 <MemberSignature Language="C#" Value="public static int printf (string format, object[] parameters);" />
1910 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 printf(string format, object[] parameters) cil managed" />
1911 <MemberType>Method</MemberType>
1913 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
1914 <AssemblyVersion>2.0.0.0</AssemblyVersion>
1915 <AssemblyVersion>4.0.0.0</AssemblyVersion>
1919 <AttributeName>System.Obsolete("Not necessarily portable due to cdecl restrictions.
1920 Use printf (string) instead.")</AttributeName>
1924 <ReturnType>System.Int32</ReturnType>
1927 <Parameter Name="format" Type="System.String" />
1928 <Parameter Name="parameters" Type="System.Object[]">
1931 <AttributeName>System.ParamArray</AttributeName>
1937 <param name="format">The message format.</param>
1938 <param name="parameters">Arguments for the message format.</param>
1939 <summary>Prints a message on <see cref="F:Mono.Unix.Native.Stdlib.stdout" />.</summary>
1940 <returns>Returns the number of characters printed or a negative value if an error occurs, and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.
1942 <block subset="none" type="usage"><para>The following errors are specified:
1943 </para><list type="table"><listheader><term>Error</term><description>Details</description></listheader><item><term><see cref="F:Mono.Unix.Native.Errno.EILSEQ" /></term><description>An invalid wide character code was encountered</description></item><item><term><see cref="F:Mono.Unix.Native.Errno.ENOMEM" /></term><description>Insufficient storage space is available.</description></item></list><para>Any of the errors documented for the <see cref="M:Mono.Unix.Native.Syscall.write" /> system call may also be returned.
1944 </para></block></returns>
1946 <para>The <c>printf</c>() family of functions produces output according to a format as described below. <c>printf</c>() writes output to the given output <paramref name="stream" />.</para>
1947 <para>These functions write the output under the control of a <paramref name="format" /> string that specifies how subsequent arguments (or arguments accessed via the variable-length argument facilities of <c>stdarg</c>(3)) are converted for output.
1949 <para>The format string is composed of zero or more directives: ordinary characters (not %), which are copied unchanged to the output stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments. Each conversion specification is introduced by the % character. The arguments must correspond properly (after type promotion) with the conversion specifier. After the %, the following appear in sequence:</para>
1950 <list type="bullet">
1952 <term>An optional field, consisting of a decimal digit string followed by a <c>$</c>, specifying the next argument to access. If this field is not provided, the argument following the last argument accessed will be used. Arguments are numbered starting at <c>1</c>. If unaccessed arguments in the format string are interspersed with ones that are accessed the results will be indeterminate.</term>
1955 <term>Zero or more of the following flags:
1957 <list type="table"><listheader><term>Flag</term><description>Description</description></listheader><item><term>'<c>#</c>'</term><description>The value should be converted to an "alternate form". For <c>c</c>, <c>d</c>, <c>i</c>, <c>n</c>, <c>p</c>, <c>s</c>, and <c>u</c> conversions, this option has no effect. For <c>o</c> conversions, the precision of the number is increased to force the first character of the output string to a zero (except if a zero value is printed with an explicit precision of zero). For <c>x</c> and <c>X</c> conversions, a non-zero result has the string '<c>0x</c>' (or '<c>0X</c>' for <c>X</c> conversions) prepended to it. For <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, and <c>G</c> conversions, the result will always contain a decimal point, even if no digits follow it (normally, a decimal point appears in the results of those conversions only if a digit follows). For <c>g</c> and <c>G</c> conversions, trailing zeros are not removed from the result as they would otherwise be.</description></item><item><term>'<c>0</c>' (zero)</term><description>Zero padding. For all conversions except <c>n</c>, the converted value is padded on the left with zeros rather than blanks. If a precision is given with a numeric conversion (<c>d</c>, <c>i</c>, <c>o</c>, <c>u</c>, <c>i</c>, <c>x</c>, and <c>X</c>), the 0 flag is ignored.</description></item><item><term>'<c>-</c>'</term><description>A negative field width flag; the converted value is to be left adjusted on the field boundary. Except for <c>n</c> conversions, the converted value is padded on the right with blanks, rather than on the left with blanks or zeros. A <c>-</c> overrides a <c>0</c> if both are given.</description></item><item><term>'<c />' (space)</term><description>A blank should be left before a positive number produced by a signed conversion (<c>a</c>, <c>A</c>, <c>d</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, <c>G</c>, or <c>i</c>).</description></item><item><term>'<c>+</c>'</term><description>A sign must always be placed before a number produced by a signed conversion. A <c>+</c> overrides a space if both are used.</description></item><item><term>'<c>'</c>'</term><description>Decimal conversions (<c>d</c>, <c>u</c>, or <c>i</c>) or the integral portion of a floating point conversion (<c>f</c> or <c>F</c>) should be grouped and separated by thousands using the non-monetary separator returned by <see cref="M:Mono.Unix.Native.Syscall.localeconv" />(3).</description></item></list></term>
1960 <term>An optional decimal digit string specifying a minimum field width. If the converted value has fewer characters than the field width, it will be padded with spaces on the left (or right, if the left-adjustment flag has been given) to fill out the field width.</term>
1963 <term>An optional precision, in the form of a period . followed by an optional digit string. If the digit string is omitted, the precision is taken as zero. This gives the minimum number of digits to appear for <c>d</c>, <c>i</c>, <c>o</c>, <c>u</c>, <c>x</c>, and <c>X</c> conversions, the number of digits to appear after the decimal-point for <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, and <c>F</c> conversions, the maximum number of significant digits for <c>g</c> and <c>G</c> conversions, or the maximum number of characters to be printed from a string for <c>s</c> conversions.</term>
1966 <term>An optional length modifier, that specifies the size of the argument. The following length modifiers are valid for the <c>d</c>, <c>i</c>, <c>n</c>, <c>o</c>, <c>u</c>, <c>x</c>, or <c>X</c> conversion:
1968 <list type="table"><listheader><term>Modifier</term><description><c>d</c>, <c>i</c></description><description><c>o, u, x, X</c></description><description><c>n</c></description></listheader><item><term><c>hh</c></term><description><c>signed char</c></description><description><c>unsigned char</c></description><description><c>signed char *</c></description></item><item><term><c>h</c></term><description><c>short</c></description><description><c>unsigned short</c></description><description><c>short *</c></description></item><item><term><c>l</c> (ell)</term><description><c>long</c></description><description><c>unsigned long</c></description><description><c>unsigned long *</c></description></item><item><term><c>ll</c> (ell ell)</term><description><c>long long</c></description><description><c>unsigned long long</c></description><description><c>long long *</c></description></item><item><term><c>j</c></term><description><c>intmax_t</c></description><description><c>uintmax_t</c></description><description><c>intmax_t *</c></description></item><item><term><c>t</c></term><description><c>ptrdiff_t</c></description><description>(see note)</description><description><c>ptrdiff_t *</c></description></item><item><term><c>z</c></term><description>(see note)</description><description><c>size_t</c></description><description>(see note)</description></item><item><term><c>q</c><i>(deprecated)</i></term><description><c>quad_t</c></description><description><c>u_quad_t</c></description><description><c>quad_t *</c></description></item></list><block subset="none" type="note"><para>the <c>t</c> modifier, when applied to a <c>o</c>, <c>u</c>, <c>x</c>, or <c>X</c> conversion, indicates that the argument is of an unsigned type equivalent in size to a <c>ptrdiff_t</c>. The <c>z</c> modifier, when applied to a <c>d</c> or <c>i</c> conversion, indicates that the argument is of a signed type equivalent in size to a <c>size_t</c>. Similarly, when applied to an <c>n</c> conversion, it indicates that the argument is a pointer to a signed type equivalent in size to a <c>size_t</c>.
1969 </para></block><para>The following length modifier is valid for the <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, or <c>G</c> conversion:</para><list type="table"><listheader><term>Modifier</term><description><c>a, A, e, E, f, F, g, G</c></description></listheader><item><term><c>L</c></term><description><c>long double</c></description></item></list><para>The following length modifier is valid for the <c>c</c> or <c>s</c> conversion:</para><list type="table"><listheader><term>Modifier</term><description><c>c</c></description><description><c>s</c></description></listheader><item><term><c>l</c> (ell)</term><description><c>wint_t</c></description><description><c>wchar_t *</c></description></item></list></term>
1972 <term>A character that specifies the type of conversion to be applied.</term>
1975 <para>A field width or precision, or both, may be indicated by an asterisk '<c>*</c>' or an asterisk followed by one or more decimal digits and a '<c>$</c>' instead of a digit string. In this case, an <i>int</i> argument supplies the field width or precision. A negative field width is treated as a left adjustment flag followed by a positive field width; a negative precision is treated as though it were missing. If a single format directive mixes positional (<c>nn$</c>) and non-positional arguments, the results are undefined
1977 <para>The conversion specifiers and their meanings are:</para>
1980 <term>Specifier</term>
1981 <description>Meaning</description>
1987 <description>The <c>int</c> (or appropriate variant) argument is converted to signed decimal (<c>d</c> and <c>i</c>), unsigned octal (<c>o</c>), unsigned decimal (<c>u</c>), or unsigned hexadecimal (<c>x</c> and <c>X</c>) notation. The letters "<c>abcdef</c>" are used for <c>x</c> conversions; the letters "<c>ABCDEF</c>" are used for <c>X</c> conversions. The precision, if any, gives the minimum number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with zeros.</description>
1993 <description>The <c>long int</c> argument is converted to signed decimal, unsigned octal, or unsigned decimal, as if the format had been <c>ld</c>, <c>lo</c>, or <c>lu</c> respectively. These conversion characters are deprecated, and will eventually disappear.</description>
1999 <description>The <c>double</c> argument is rounded and converted in the style <c>[-]d.ddde±dd</c> where there is one digit before the decimal-point character and the number of digits after it is equal to the precision; if the precision is missing, it is taken as 6; if the precision is zero, no decimal-point character appears. An <c>E</c> conversion uses the letter '<c>E</c>' (rather than '<c>e</c>') to introduce the exponent. The exponent always contains at least two digits; if the value is zero, the exponent is 00.</description>
2000 <para>For <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, and <c>G</c> conversions, positive and negative infinity are represented as <c>inf</c> and <c>-inf</c> respectively when using the lowercase conversion character, and <c>INF</c> and <c>-INF</c> respectively when using the uppercase conversion character. Similarly, <c>NaN</c> is represented as <c>nan</c> when using the lowercase conversion, and <c>NAN</c> when using the uppercase conversion.</para>
2006 <description>The <c>double</c> argument is rounded and converted to decimal notation in the style <c>[-]ddd.ddd</c>, where the number of digits after the decimal-point character is equal to the precision specification. If the precision is missing, it is taken as 6; if the precision is explicitly zero, no decimal-point character appears. If a decimal point appears, at least one digit appears before it.</description>
2012 <description>The <c>double</c> argument is converted in style <c>f</c> or <c>e</c> (or <c>F</c> or <c>E</c> for <c>G</c> conversions). The precision specifies the number of significant digits. If the precision is missing, 6 digits are given; if the precision is zero, it is treated as 1. Style <c>e</c> is used if the exponent from its conversion is less than -4 or greater than or equal to the precision. Trailing zeros are removed from the fractional part of the result; a decimal point appears only if it is followed by at least one digit.</description>
2018 <description>The <c>double</c> argument is rounded and converted to hexadecimal notation in the style <c>[-]0xh.hhhp[±]d</c>, where the number of digits after the hexadecimal-point character is equal to the precision specification. If the precision is missing, it is taken as enough to represent the floating-point number exactly, and no rounding occurs. If the precision is zero, no hexadecimal-point character appears. The <c>p</c> is a literal character '<c>p</c>', and the exponent consists of a positive or negative sign followed by a decimal number representing an exponent of 2. The <c>A</c> conversion uses the prefix "<c>0X</c>" (rather than "<c>0x</c>"), the letters "<c>ABCDEF</c>" (rather than "<c>abcdef</c>") to represent the hex digits, and the letter '<c>P</c>' (rather than '<c>p</c>') to separate the mantissa and exponent.
2020 <para>Note that there may be multiple valid ways to represent floating-point numbers in this hexadecimal format. For example, <c>0x3.24p+0</c>, <c>0x6.48p-1</c> and <c>0xc.9p-2</c> are all equivalent. The format chosen depends on the internal representation of the number, but the implementation guarantees that the length of the mantissa will be minimized. Zeroes are always represented with a mantissa of 0 (preceded by a '<c>-</c>' if appropriate) and an exponent of +0.
2021 </para></description>
2027 <description>Treated as <c>c</c> with the <c>l</c> (ell) modifier.</description>
2033 <description>The <c>int</c> argument is converted to an <c>unsigned char</c>, and the resulting character is written.
2035 <para>If the <c>l</c> (ell) modifier is used, the <c>wint_t</c> argument shall be converted to a <c>wchar_t</c>, and the (potentially multi-byte) sequence representing the single wide character is written, including any shift sequences. If a shift sequence is used, the shift state is also restored to the original state after the character.
2036 </para></description>
2042 <description>Treated as <c>s</c> with the <c>l</c> (ell) modifier.</description>
2049 The <c>char *</c> argument is expected to be a pointer to an array of character type (pointer to a string). Characters from the array are written up to (but not including) a terminating NUL character; if a precision is specified, no more than the number specified are written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the size of the array, the array must contain a terminating NUL character.
2051 <para>If the <c>l</c> (ell) modifier is used, the <c>wchar_t *</c> argument is expected to be a pointer to an array of wide characters (pointer to a wide string). For each wide character in the string, the (potentially multi-byte) sequence representing the wide character is written, including any shift sequences. If any shift sequence is used, the shift state is also restored to the original state after the string. Wide characters from the array are written up to (but not including) a terminating wide NUL character; if a precision is specified, no more than the number of bytes specified are written (including shift sequences). Partial characters are never written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the number of bytes required to render the multibyte representation of the string, the array must contain a terminating wide NUL character.</para></description>
2057 <description>The <c>void *</c> pointer argument is printed in hexadecimal (as if by '<c>%#x</c>' or '<c>%#lx</c>').</description>
2063 <description>The number of characters written so far is stored into the integer indicated by the <c>int *</c> (or variant) pointer argument. No argument is converted.</description>
2069 <description> A '<c>%</c>' is written. No argument is converted. The complete conversion specification is '<c>%%</c>'.</description>
2072 <para>The decimal point character is defined in the program's locale (category <c>LC_NUMERIC</c>)
2074 <para>In no case does a non-existent or small field width cause truncation of a numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result.</para>
2078 <Member MemberName="putc">
2079 <MemberSignature Language="C#" Value="public static int putc (int c, IntPtr stream);" />
2080 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "putc" cdecl lasterr)int32 putc(int32 c, native int stream) cil managed" />
2081 <MemberType>Method</MemberType>
2083 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2084 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2085 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2088 <ReturnType>System.Int32</ReturnType>
2091 <Parameter Name="c" Type="System.Int32" />
2092 <Parameter Name="stream" Type="System.IntPtr" />
2095 <param name="c">The charater to write.</param>
2096 <param name="stream">The <c>FILE</c> stream to write to.</param>
2097 <summary>Output a character to a <c>FILE</c> stream.</summary>
2098 <returns>Returns the character written. If an error occurrs, the value <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> is returned.</returns>
2099 <remarks>The <c>putc</c>() function writes the character <paramref name="c" /> (converted to an "unsigned char") to the output stream pointed to by <paramref name="stream" />.</remarks>
2102 <Member MemberName="putchar">
2103 <MemberSignature Language="C#" Value="public static int putchar (int c);" />
2104 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "putchar" cdecl lasterr)int32 putchar(int32 c) cil managed" />
2105 <MemberType>Method</MemberType>
2107 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2108 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2109 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2112 <ReturnType>System.Int32</ReturnType>
2115 <Parameter Name="c" Type="System.Int32" />
2118 <param name="c">The charater to write.</param>
2119 <summary>Output a character to a <see cref="F:Mono.Unix.Native.Stdlib.stdout" />.</summary>
2120 <returns>Returns the character written. If an error occurrs, the value <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> is returned.</returns>
2121 <remarks>The <c>putchar</c>() function is identical to <see cref="M:Mono.Unix.Native.Stdlib.putc" />() with an output stream of <see cref="F:Mono.Unix.Native.Stdlib.stdout" />.</remarks>
2124 <Member MemberName="puts">
2125 <MemberSignature Language="C#" Value="public static int puts (string s);" />
2126 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "puts" cdecl lasterr)int32 puts(string s) cil managed" />
2127 <MemberType>Method</MemberType>
2129 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2130 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2131 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2134 <ReturnType>System.Int32</ReturnType>
2137 <Parameter Name="s" Type="System.String" />
2140 <param name="s">To be added.</param>
2141 <summary>Output a line to <see cref="F:Mono.Unix.Native.Stdlib.stdout" />.</summary>
2143 <para>The <c>fputs</c> function returns <c>0</c> on success and <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> on error, and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
2144 <block subset="none" type="usage">
2145 <para>The following errors are specified:</para>
2149 <description>Details</description>
2153 <see cref="F:Mono.Unix.Native.Errno.EBADF" />
2155 <description>The <paramref name="stream" /> argument not a writable stream.</description>
2160 <c>fputs</c> may also fail for any of the errors specified for the routines <see cref="M:Mono.Unix.Native.Syscall.write" />(2).
2163 <remarks>The function <c>puts</c>() writes the string <paramref name="s" />, and a terminating newline character, to the stream <see cref="F:Mono.Unix.Native.Stdlib.stdout" />.</remarks>
2166 <Member MemberName="raise">
2167 <MemberSignature Language="C#" Value="public static int raise (Mono.Unix.Native.RealTimeSignum rts);" />
2168 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 raise(valuetype Mono.Unix.Native.RealTimeSignum rts) cil managed" />
2169 <MemberType>Method</MemberType>
2171 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2172 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2175 <ReturnType>System.Int32</ReturnType>
2178 <Parameter Name="rts" Type="Mono.Unix.Native.RealTimeSignum" />
2181 <param name="rts">A realtime signal to send to the current process.</param>
2182 <summary>Send a realtime signal to the current process.</summary>
2183 <returns>The <c>raise</c>() function returns the value 0 if successful; otherwise the value -1 is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.
2185 <remarks>The <c>raise</c>() function sends the signal <paramref name="sig" /> to the current process.</remarks>
2188 <Member MemberName="raise">
2189 <MemberSignature Language="C#" Value="public static int raise (Mono.Unix.Native.Signum sig);" />
2190 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 raise(valuetype Mono.Unix.Native.Signum sig) cil managed" />
2191 <MemberType>Method</MemberType>
2193 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2194 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2195 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2199 <AttributeName>System.CLSCompliant(false)</AttributeName>
2203 <ReturnType>System.Int32</ReturnType>
2206 <Parameter Name="sig" Type="Mono.Unix.Native.Signum" />
2209 <param name="sig">A signal to send to the current process.</param>
2210 <summary>Send a signal to the current process.</summary>
2211 <returns>The <c>raise</c>() function returns the value 0 if successful; otherwise the value -1 is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.
2213 <remarks>The <c>raise</c>() function sends the signal <paramref name="sig" /> to the current process.</remarks>
2216 <Member MemberName="rand">
2217 <MemberSignature Language="C#" Value="public static int rand ();" />
2218 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "rand" cdecl)int32 rand() cil managed" />
2219 <MemberType>Method</MemberType>
2221 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2222 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2223 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2226 <ReturnType>System.Int32</ReturnType>
2230 <summary>Generates a random number.</summary>
2231 <returns>To be added.</returns>
2232 <remarks>The <c>rand</c>() function computes a sequence of pseudo-random integers in the range of 0 to <see cref="F:Mono.Unix.Native.Stdlib.RAND_MAX" /></remarks>
2235 <Member MemberName="RAND_MAX">
2236 <MemberSignature Language="C#" Value="public static readonly int RAND_MAX;" />
2237 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 RAND_MAX" />
2238 <MemberType>Field</MemberType>
2240 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2241 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2242 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2246 <AttributeName>System.CLSCompliant(false)</AttributeName>
2250 <ReturnType>System.Int32</ReturnType>
2252 <MemberValue>2147483647</MemberValue>
2254 <summary>The maximum value returned by <see cref="M:Mono.Unix.Native.Stdlib.rand" />(3).</summary>
2255 <remarks>The maximum value returned by <see cref="M:Mono.Unix.Native.Stdlib.rand" />(3).</remarks>
2258 <Member MemberName="realloc">
2259 <MemberSignature Language="C#" Value="public static IntPtr realloc (IntPtr ptr, ulong size);" />
2260 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_realloc" cdecl lasterr)native int realloc(native int ptr, unsigned int64 size) cil managed" />
2261 <MemberType>Method</MemberType>
2263 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2264 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2265 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2269 <AttributeName>System.CLSCompliant(false)</AttributeName>
2273 <ReturnType>System.IntPtr</ReturnType>
2276 <Parameter Name="ptr" Type="System.IntPtr" />
2277 <Parameter Name="size" Type="System.UInt64" />
2280 <param name="ptr">Pointer to the start of a memory area to reallocate.</param>
2281 <param name="size">The new size for the allocated memory.</param>
2282 <summary>Reallocate a memory block.</summary>
2283 <returns>The <c>realloc</c>() function returns a pointer, possibly identical to <paramref name="ptr" />, to the allocated memory if successful; otherwise a <see cref="F:System.IntPtr.Zero" /> pointer is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> returns <see cref="F:Mono.Unix.Native.Errno.ENOMEM" />. The <c>realloc</c>() function always leaves the original buffer intact when an error occurs.</returns>
2284 <remarks>The <c>realloc</c>() function changes the size of the previously allocated memory referenced by <paramref name="ptr" /> to <paramref name="size" /> bytes. The contents of the memory are unchanged up to the lesser of the new and old sizes. If the new size is larger, the value of the newly allocated portion of the memory is undefined. If the requested memory cannot be allocated, <see cref="F:System.IntPtr.Zero" /> is returned and the memory referenced by <paramref name="ptr" /> is valid and unchanged. If memory can be allocated, the memory referenced by <paramref name="ptr" /> is freed and a pointer to the newly allocated memory is returned. Note that this may be different from the value passed as <paramref name="ptr" />. If <paramref name="ptr" /> is <see cref="F:System.IntPtr.Zero" />, the <c>realloc</c>() function behaves identically to <see cref="M:Mono.Unix.Native.Stdlib.malloc" />() for the specified size.</remarks>
2287 <Member MemberName="remove">
2288 <MemberSignature Language="C#" Value="public static int remove (string filename);" />
2289 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "remove" cdecl lasterr)int32 remove(string filename) cil managed" />
2290 <MemberType>Method</MemberType>
2292 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2293 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2294 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2297 <ReturnType>System.Int32</ReturnType>
2300 <Parameter Name="filename" Type="System.String" />
2303 <param name="filename">To be added.</param>
2304 <summary>Remove a directory entry.</summary>
2305 <returns>The <c>remove</c>() function returns the value 0 if successful; otherwise the value -1 is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</returns>
2307 <para>The <c>remove</c>() function removes the file or directory specified by <paramref name="path" />.</para>
2308 <para>If <paramref name="path" /> specifies a directory, <c>remove(<paramref name="path" />)</c> is the equivalent of <c><see cref="M:Mono.Unix.Native.Syscall.rmdir" />(<paramref name="path" />)</c>. Otherwise, it is the equivalent of <c><see cref="M:Mono.Unix.Native.Syscall.unlink" />(<paramref name="path" />)</c>.
2313 <Member MemberName="rename">
2314 <MemberSignature Language="C#" Value="public static int rename (string oldpath, string newpath);" />
2315 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "rename" cdecl lasterr)int32 rename(string oldpath, string newpath) cil managed" />
2316 <MemberType>Method</MemberType>
2318 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2319 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2320 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2323 <ReturnType>System.Int32</ReturnType>
2326 <Parameter Name="oldpath" Type="System.String" />
2327 <Parameter Name="newpath" Type="System.String" />
2330 <param name="oldpath">The old path name.</param>
2331 <param name="newpath">The new path name.</param>
2332 <summary>Rename oldpath to newpath.</summary>
2333 <returns>The <c>rename</c>() function returns the value 0 if successful; otherwise the value -1 is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</returns>
2335 <para>The <c>rename</c>() system call causes the link named <paramref name="oldpath" /> to be renamed as <paramref name="newpath" />. If <paramref name="newpath" /> exists, it is first removed. Both <paramref name="oldpath" /> and <paramref name="newpath" /> must be of the same type (that is, both directories or both non-directories), and must reside on the same file system.</para>
2336 <para>The <c>rename</c>() system call guarantees that if <paramref name="newpath" /> already exists, an instance of <paramref name="newpath" /> will always exist, even if the system should crash in the middle of the operation.</para>
2337 <para>If the final component of <paramref name="oldpath" /> is a symbolic link, the symbolic link is renamed, not the file or directory to which it points.</para>
2341 <Member MemberName="rewind">
2342 <MemberSignature Language="C#" Value="public static int rewind (IntPtr stream);" />
2343 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_rewind" cdecl lasterr)int32 rewind(native int stream) cil managed" />
2344 <MemberType>Method</MemberType>
2346 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2347 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2348 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2351 <ReturnType>System.Int32</ReturnType>
2354 <Parameter Name="stream" Type="System.IntPtr" />
2357 <param name="stream">
2358 <c>FILE</c> stream to set file position indicator to the beginning of the file.</param>
2359 <summary>Set the file position indicator of the <c>FILE</c> stream to the beginning of the file.</summary>
2360 <returns>To be added.</returns>
2362 <para>The <c>rewind</c>() function sets the file position indicator for the stream pointed to by <paramref name="stream" /> to the beginning of the file. It is equivalent to:</para>
2364 <see cref="M:Mono.Unix.Native.Stdlib.fseek" />(<paramref name="stream" />, 0, <see cref="F:Mono.Unix.Native.SeekFlags.SEEK_SET" />)
2366 <para>except that the error indicator for the stream is also cleared (see <see cref="M:Mono.Unix.Native.Stdlib.clearerr" />(3)).</para>
2367 <para>Since <c>rewind</c>() does not return a value, an application wishing to detect errors should call <c><see cref="M:Mono.Unix.Native.Stdlib.SetLastError" />((<see cref="T:Mono.Unix.Native.Error" />)0)</c>, then call <c>rewind</c>(), and if <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> is non-zero, assume an error has occurred.</para>
2371 <Member MemberName="setbuf">
2372 <MemberSignature Language="C#" Value="public static int setbuf (IntPtr stream, byte* buf);" />
2373 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 setbuf(native int stream, unsigned int8* buf) cil managed" />
2374 <MemberType>Method</MemberType>
2376 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2377 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2378 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2382 <AttributeName>System.CLSCompliant(false)</AttributeName>
2386 <ReturnType>System.Int32</ReturnType>
2389 <Parameter Name="stream" Type="System.IntPtr" />
2390 <Parameter Name="buf" Type="System.Byte*" />
2393 <param name="stream">The <c>FILE</c> stream to set buffering operations on.</param>
2394 <param name="buf">The buffer to use for buffering.</param>
2395 <summary>Control <c>FILE</c> stream buffering operations.</summary>
2396 <returns>The <c>setbuf</c>() function returns the value 0 if successful; otherwise the value -1 is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</returns>
2398 <para>The <c>setbuf</c> function disables <c>FILE</c> stream buffering if <paramref name="buf" /> is <see cref="F:System.IntPtr.Zero" />, otherwise full buffering is enabled (and <paramref name="buf" /> is used as the buffer).
2400 <para>The <c>setbuf</c> function is an alias for calls to <see /><see cref="M:Mono.Unix.Native.Stdlib.setvbuf" />. Except for the lack of a return value, the <c>setbuf</c> function is exactly equivalent to the call:</para>
2402 <see cref="M:Mono.Unix.Native.Stdlib.setvbuf" /> (<paramref name="stream" />, <paramref name="buf" />, <paramref name="buf" /> ? <see cref="M:Mono.Unix.Native.Stdlib._IOFBF" /> : <see cref="M:Mono.Unix.Native.Stdlib._IONBF" />, <see cref="M:Mono.Unix.Native.Stdlib.BUFSIZ" />);
2404 <para>This function requires that <paramref name="buf" /> refer to at least <see cref="M:Mono.Unix.Native.Stdlib.BUFSIZ" /> bytes of memory. This memory must remain valid until the next <c>setbuf</c>, <see cref="M:Mono.Unix.Native.Stdlib.setvbuf" />, or <see cref="M:Mono.Unix.Native.Stdlib.fclose" /> call.
2409 <Member MemberName="setbuf">
2410 <MemberSignature Language="C#" Value="public static int setbuf (IntPtr stream, IntPtr buf);" />
2411 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_setbuf" cdecl lasterr)int32 setbuf(native int stream, native int buf) cil managed" />
2412 <MemberType>Method</MemberType>
2414 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2415 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2416 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2419 <ReturnType>System.Int32</ReturnType>
2422 <Parameter Name="stream" Type="System.IntPtr" />
2423 <Parameter Name="buf" Type="System.IntPtr" />
2426 <param name="stream">The <c>FILE</c> stream to set buffering operations on.</param>
2427 <param name="buf">The buffer to use for buffering.</param>
2428 <summary>Control <c>FILE</c> stream buffering operations.</summary>
2429 <returns>The <c>setbuf</c>() function returns the value 0 if successful; otherwise the value -1 is returned and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</returns>
2431 <para>The <c>setbuf</c> function disables <c>FILE</c> stream buffering if <paramref name="buf" /> is <see cref="F:System.IntPtr.Zero" />, otherwise full buffering is enabled (and <paramref name="buf" /> is used as the buffer).
2433 <para>The <c>setbuf</c> function is an alias for calls to <see /><see cref="M:Mono.Unix.Native.Stdlib.setvbuf" />. Except for the lack of a return value, the <c>setbuf</c> function is exactly equivalent to the call:</para>
2435 <see cref="M:Mono.Unix.Native.Stdlib.setvbuf" /> (<paramref name="stream" />, <paramref name="buf" />, <paramref name="buf" /> ? <see cref="M:Mono.Unix.Native.Stdlib._IOFBF" /> : <see cref="M:Mono.Unix.Native.Stdlib._IONBF" />, <see cref="M:Mono.Unix.Native.Stdlib.BUFSIZ" />);
2437 <para>This function requires that <paramref name="buf" /> refer to at least <see cref="M:Mono.Unix.Native.Stdlib.BUFSIZ" /> bytes of memory. This memory must remain valid until the next <c>setbuf</c>, <see cref="M:Mono.Unix.Native.Stdlib.setvbuf" />, or <see cref="M:Mono.Unix.Native.Stdlib.fclose" /> call.
2442 <Member MemberName="SetLastError">
2443 <MemberSignature Language="C#" Value="protected static void SetLastError (Mono.Unix.Native.Errno error);" />
2444 <MemberSignature Language="ILAsm" Value=".method familystatic hidebysig void SetLastError(valuetype Mono.Unix.Native.Errno error) cil managed" />
2445 <MemberType>Method</MemberType>
2447 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2448 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2449 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2452 <ReturnType>System.Void</ReturnType>
2455 <Parameter Name="error" Type="Mono.Unix.Native.Errno" />
2458 <param name="error">To be added.</param>
2459 <summary>Writes <c>errno</c>.</summary>
2460 <remarks>To be added.</remarks>
2463 <Member MemberName="SetSignalAction">
2464 <MemberSignature Language="C#" Value="public static int SetSignalAction (Mono.Unix.Native.RealTimeSignum rts, Mono.Unix.Native.SignalAction action);" />
2465 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 SetSignalAction(valuetype Mono.Unix.Native.RealTimeSignum rts, valuetype Mono.Unix.Native.SignalAction action) cil managed" />
2466 <MemberType>Method</MemberType>
2468 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2469 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2472 <ReturnType>System.Int32</ReturnType>
2475 <Parameter Name="rts" Type="Mono.Unix.Native.RealTimeSignum" />
2476 <Parameter Name="action" Type="Mono.Unix.Native.SignalAction" />
2479 <param name="rts">To be added.</param>
2480 <param name="action">
2481 A <see cref="T:Mono.Unix.Native.SignalAction" /> specifying what to
2482 do when the <paramref name="signum" /> signal is emitted.
2485 Specifies what should happen when a signal is emitted.
2489 A <see cref="T:System.Int32" />; if equal to <c>0</c>, the call
2490 was successful. <c>-1</c> is returned on failure, and sets
2491 <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" />
2492 to indicate the error.
2494 <block subset="none" type="usage">
2496 Possible errors include:
2509 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
2513 <paramref name="signum" /> is invalid.
2522 This is the safer, restricted form of
2523 <see cref="M:Mono.Unix.Native.Stdlib.signal(Mono.Unix.Native.RealTimeSignum,Mono.Unix.Native.SignalHandler)" />.
2524 While <c>signal</c>(2) permits an arbitrary method to be set as
2525 the signal handler, this method permits specifying only the
2526 default, ignore, or error handlers.
2528 <block subset="none" type="behaviors">
2530 If <paramref name="action" /> is
2531 <see cref="F:Mono.Unix.Native.SignalAction.Default" />, then
2532 this method is equivalent to
2533 <c>signal(<paramref name="signum" />, SIG_DFL)</c>.
2536 If <paramref name="action" /> is
2537 <see cref="F:Mono.Unix.Native.SignalAction.Ignore" />, then
2538 this method is equivalent to
2539 <c>signal(<paramref name="signum" />, SIG_IGN)</c>.
2542 If <paramref name="action" /> is
2543 <see cref="F:Mono.Unix.Native.SignalAction.Error" />, then
2544 this method is equivalent to
2545 <c>signal(<paramref name="signum" />, SIG_ERR)</c>.
2551 <Member MemberName="SetSignalAction">
2552 <MemberSignature Language="C#" Value="public static int SetSignalAction (Mono.Unix.Native.Signum signal, Mono.Unix.Native.SignalAction action);" />
2553 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 SetSignalAction(valuetype Mono.Unix.Native.Signum signal, valuetype Mono.Unix.Native.SignalAction action) cil managed" />
2554 <MemberType>Method</MemberType>
2556 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2557 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2558 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2561 <ReturnType>System.Int32</ReturnType>
2564 <Parameter Name="signal" Type="Mono.Unix.Native.Signum" />
2565 <Parameter Name="action" Type="Mono.Unix.Native.SignalAction" />
2568 <param name="signal">To be added.</param>
2569 <param name="action">
2570 A <see cref="T:Mono.Unix.Native.SignalAction" /> specifying what to
2571 do when the <paramref name="signum" /> signal is emitted.
2574 Specifies what should happen when a signal is emitted.
2578 A <see cref="T:System.Int32" />; if equal to <c>0</c>, the call
2579 was successful. <c>-1</c> is returned on failure, and sets
2580 <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" />
2581 to indicate the error.
2583 <block subset="none" type="usage">
2585 Possible errors include:
2598 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
2602 <paramref name="signum" /> is invalid.
2611 This is the safer, restricted form of
2612 <see cref="M:Mono.Unix.Native.Stdlib.signal(Mono.Unix.Native.Signum,Mono.Unix.Native.SignalHandler)" />.
2613 While <c>signal</c>(2) permits an arbitrary method to be set as
2614 the signal handler, this method permits specifying only the
2615 default, ignore, or error handlers.
2617 <block subset="none" type="behaviors">
2619 If <paramref name="action" /> is
2620 <see cref="F:Mono.Unix.Native.SignalAction.Default" />, then
2621 this method is equivalent to
2622 <c>signal(<paramref name="signum" />, SIG_DFL)</c>.
2625 If <paramref name="action" /> is
2626 <see cref="F:Mono.Unix.Native.SignalAction.Ignore" />, then
2627 this method is equivalent to
2628 <c>signal(<paramref name="signum" />, SIG_IGN)</c>.
2631 If <paramref name="action" /> is
2632 <see cref="F:Mono.Unix.Native.SignalAction.Error" />, then
2633 this method is equivalent to
2634 <c>signal(<paramref name="signum" />, SIG_ERR)</c>.
2640 <Member MemberName="setvbuf">
2641 <MemberSignature Language="C#" Value="public static int setvbuf (IntPtr stream, byte* buf, int mode, ulong size);" />
2642 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 setvbuf(native int stream, unsigned int8* buf, int32 mode, unsigned int64 size) cil managed" />
2643 <MemberType>Method</MemberType>
2645 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2646 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2647 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2651 <AttributeName>System.CLSCompliant(false)</AttributeName>
2655 <ReturnType>System.Int32</ReturnType>
2658 <Parameter Name="stream" Type="System.IntPtr" />
2659 <Parameter Name="buf" Type="System.Byte*" />
2660 <Parameter Name="mode" Type="System.Int32" />
2661 <Parameter Name="size" Type="System.UInt64" />
2664 <param name="stream">The <c>FILE</c> stream to set buffering behavior on.</param>
2665 <param name="buf">The buffer to use for buffering.</param>
2666 <param name="mode">The type of buffering to start using with <paramref name="stream" />.</param>
2667 <param name="size">The size of the buffer <paramref name="buf" />.</param>
2668 <summary>Control <c>FILE</c> stream buffering operations.</summary>
2669 <returns>The <c>setvbuf</c>() function returns 0 on success, or <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> if the request cannot be honored (note that the stream is still functional in this case).</returns>
2671 <para>The three types of buffering available are unbuffered, block buffered, and line buffered. When an output stream is unbuffered, information appears on the destination file or terminal as soon as written; when it is block buffered many characters are saved up and written as a block; when it is line buffered characters are saved up until a new- line is output or input is read from any stream attached to a terminal device (typically <see cref="F:Mono.Unix.Native.Stdlib.stdin" />). The function <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3) may be used to force the block out early. (See <see cref="M:Mono.Unix.Native.Stdlib.fclose" />(3).)
2673 <para>Normally all files are block buffered. When the first I/O operation occurs on a file, <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3) is called, and an optimally-sized buffer is obtained. If a stream refers to a terminal (as <see cref="F:Mono.Unix.Native.Stdlib.stdout" /> normally does) it is line buffered. The standard error stream <see cref="F:Mono.Unix.Native.Stdlib.stderr" /> is always unbuffered.</para>
2674 <para>The <c>setvbuf</c> function may be used to alter the buffering behavior of a stream. The <paramref name="mode" /> argument must be one of the following three values:
2679 <description>Description</description>
2683 <see cref="F:Mono.Unix.Native.Stdlib._IONBF" />
2685 <description>unbuffered</description>
2689 <see cref="F:Mono.Unix.Native.Stdlib._IOLBF" />
2691 <description>line buffered</description>
2695 <see cref="F:Mono.Unix.Native.Stdlib._IOFBF" />
2697 <description>fully buffered</description>
2700 <para>The <paramref name="size" /> argument may be given as zero to obtain deferred optimal-size buffer allocation as usual. If it is not zero, then except for unbuffered files, the <paramref name="buf" /> argument should point to a buffer at least <paramref name="size" /> bytes long; this buffer will be used instead of the current buffer. If <paramref name="buf" /> is not <see langword="null" />, it is the caller's responsibility to <see cref="M:Mono.Unix.Native.Stdlib.free" />(3) this buffer after closing the stream.
2702 <para>The <c>setvbuf</c>() function may be used at any time, but may have peculiar side effects (such as discarding input or flushing output) if the stream is ''active''. Portable applications should call it only once on any given stream, and before any I/O is performed.
2707 <Member MemberName="setvbuf">
2708 <MemberSignature Language="C#" Value="public static int setvbuf (IntPtr stream, IntPtr buf, int mode, ulong size);" />
2709 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_setvbuf" cdecl lasterr)int32 setvbuf(native int stream, native int buf, int32 mode, unsigned int64 size) cil managed" />
2710 <MemberType>Method</MemberType>
2712 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2713 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2714 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2718 <AttributeName>System.CLSCompliant(false)</AttributeName>
2722 <ReturnType>System.Int32</ReturnType>
2725 <Parameter Name="stream" Type="System.IntPtr" />
2726 <Parameter Name="buf" Type="System.IntPtr" />
2727 <Parameter Name="mode" Type="System.Int32" />
2728 <Parameter Name="size" Type="System.UInt64" />
2731 <param name="stream">The <c>FILE</c> stream to set buffering behavior on.</param>
2732 <param name="buf">The buffer to use for buffering.</param>
2733 <param name="mode">The type of buffering to start using with <paramref name="stream" />.</param>
2734 <param name="size">The size of the buffer <paramref name="buf" />.</param>
2735 <summary>Control <c>FILE</c> stream buffering.</summary>
2736 <returns>The <c>setvbuf</c>() function returns 0 on success, or <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> if the request cannot be honored (note that the stream is still functional in this case).</returns>
2738 <para>The three types of buffering available are unbuffered, block buffered, and line buffered. When an output stream is unbuffered, information appears on the destination file or terminal as soon as written; when it is block buffered many characters are saved up and written as a block; when it is line buffered characters are saved up until a new- line is output or input is read from any stream attached to a terminal device (typically <see cref="F:Mono.Unix.Native.Stdlib.stdin" />). The function <see cref="M:Mono.Unix.Native.Stdlib.fflush" />(3) may be used to force the block out early. (See <see cref="M:Mono.Unix.Native.Stdlib.fclose" />(3).)
2740 <para>Normally all files are block buffered. When the first I/O operation occurs on a file, <see cref="M:Mono.Unix.Native.Stdlib.malloc" />(3) is called, and an optimally-sized buffer is obtained. If a stream refers to a terminal (as <see cref="F:Mono.Unix.Native.Stdlib.stdout" /> normally does) it is line buffered. The standard error stream <see cref="F:Mono.Unix.Native.Stdlib.stderr" /> is always unbuffered.</para>
2741 <para>The <c>setvbuf</c> function may be used to alter the buffering behavior of a stream. The <paramref name="mode" /> argument must be one of the following three values:
2746 <description>Description</description>
2750 <see cref="F:Mono.Unix.Native.Stdlib._IONBF" />
2752 <description>unbuffered</description>
2756 <see cref="F:Mono.Unix.Native.Stdlib._IOLBF" />
2758 <description>line buffered</description>
2762 <see cref="F:Mono.Unix.Native.Stdlib._IOFBF" />
2764 <description>fully buffered</description>
2767 <para>The <paramref name="size" /> argument may be given as zero to obtain deferred optimal-size buffer allocation as usual. If it is not zero, then except for unbuffered files, the <paramref name="buf" /> argument should point to a buffer at least <paramref name="size" /> bytes long; this buffer will be used instead of the current buffer. If <paramref name="buf" /> is not <see cref="System.IntPtr.Zero" />, it is the caller's responsibility to <see cref="M:Mono.Unix.Native.Stdlib.free" />(3) this buffer after closing the stream.
2769 <para>The <c>setvbuf</c>() function may be used at any time, but may have peculiar side effects (such as discarding input or flushing output) if the stream is ''active''. Portable applications should call it only once on any given stream, and before any I/O is performed.
2774 <Member MemberName="SIG_DFL">
2775 <MemberSignature Language="C#" Value="public static readonly Mono.Unix.Native.SignalHandler SIG_DFL;" />
2776 <MemberSignature Language="ILAsm" Value=".field public static initonly class Mono.Unix.Native.SignalHandler SIG_DFL" />
2777 <MemberType>Field</MemberType>
2779 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2780 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2781 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2785 <AttributeName>System.CLSCompliant(false)</AttributeName>
2789 <ReturnType>Mono.Unix.Native.SignalHandler</ReturnType>
2792 <summary>Default signal behavior.</summary>
2793 <remarks>To be added.</remarks>
2796 <Member MemberName="SIG_ERR">
2797 <MemberSignature Language="C#" Value="public static readonly Mono.Unix.Native.SignalHandler SIG_ERR;" />
2798 <MemberSignature Language="ILAsm" Value=".field public static initonly class Mono.Unix.Native.SignalHandler SIG_ERR" />
2799 <MemberType>Field</MemberType>
2801 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2802 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2803 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2807 <AttributeName>System.CLSCompliant(false)</AttributeName>
2811 <ReturnType>Mono.Unix.Native.SignalHandler</ReturnType>
2814 <summary>Error signal.</summary>
2815 <remarks>This value is returned by <see cref="M:Mono.Unix.Native.Stdlib.signal" />(3) when an error occurs.</remarks>
2818 <Member MemberName="SIG_IGN">
2819 <MemberSignature Language="C#" Value="public static readonly Mono.Unix.Native.SignalHandler SIG_IGN;" />
2820 <MemberSignature Language="ILAsm" Value=".field public static initonly class Mono.Unix.Native.SignalHandler SIG_IGN" />
2821 <MemberType>Field</MemberType>
2823 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2824 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2825 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2829 <AttributeName>System.CLSCompliant(false)</AttributeName>
2833 <ReturnType>Mono.Unix.Native.SignalHandler</ReturnType>
2836 <summary>Ignore the signal.</summary>
2837 <remarks>To be added.</remarks>
2840 <Member MemberName="signal">
2841 <MemberSignature Language="C#" Value="public static Mono.Unix.Native.SignalHandler signal (Mono.Unix.Native.Signum signum, Mono.Unix.Native.SignalHandler handler);" />
2842 <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Mono.Unix.Native.SignalHandler signal(valuetype Mono.Unix.Native.Signum signum, class Mono.Unix.Native.SignalHandler handler) cil managed" />
2843 <MemberType>Method</MemberType>
2845 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2846 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2847 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2851 <AttributeName>System.CLSCompliant(false)</AttributeName>
2854 <AttributeName>System.Obsolete("This is not safe; use Mono.Unix.UnixSignal for signal delivery or SetSignalAction()")</AttributeName>
2858 <ReturnType>Mono.Unix.Native.SignalHandler</ReturnType>
2861 <Parameter Name="signum" Type="Mono.Unix.Native.Signum" />
2862 <Parameter Name="handler" Type="Mono.Unix.Native.SignalHandler" />
2865 <param name="signum">The signal to handle.</param>
2866 <param name="handler">The handler to invoke when the process receives a <paramref name="signum" /> signal.</param>
2867 <summary>Register a handler for a given signal.</summary>
2869 <para>The previous value of the signal handler, or <see cref="F:Mono.Unix.Native.Stdlib.SIG_ERR" /> on error and <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> indicates the error.</para>
2870 <block subset="none" type="usage">
2871 <para>The following errors are specified:</para>
2875 <description>Details</description>
2879 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
2881 <description>The <paramref name="signum" /> argument is not a valid signal number.</description>
2885 <see cref="F:Mono.Unix.Native.Errno.EINVAL" />
2887 <description>An attempt is made to ignore or supply a handler for <see cref="F:Mono.Unix.Native.Signum.SIGKILL" /> or <see cref="F:Mono.Unix.Native.Signum.SIGSTOP" />.</description>
2893 <block subset="none" type="note">
2895 This method should not be used in new code, as the Platform Invoke
2896 mechanism is not signal-safe, yet the Platform Invoke mechanism is
2897 required for unmanaged code to invoke managed code.
2900 New code should use the replacement method
2901 <see cref="M:Mono.Unix.Native.Stdlib.SetSignalAction" /> or the
2902 type <see cref="T:Mono.Unix.UnixSignal" />.
2905 <para>This signal() facility is a simplified interface to the more general <see cref="M:Mono.Unix.Native.Syscall.sigaction" />(2) facility.</para>
2906 <para>Signals allow the manipulation of a process from outside its domain as well as allowing the process to manipulate itself or copies of itself (children). There are two general types of signals: those that cause termination of a process and those that do not. Signals which cause termination of a program might result from an irrecoverable error or might be the result of a user at a terminal typing the 'interrupt' character. Signals are used when a process is stopped because it wishes to access its control terminal while in the background (see <c>tty</c>(4)). Signals are optionally generated when a process resumes after being stopped, when the status of child processes changes, or when input is ready at the control terminal. Most signals result in the termination of the process receiving them if no action is taken; some signals instead cause the process receiving them to be stopped, or are simply discarded if the process has not requested otherwise. Except for the <see cref="F:Mono.Unix.Native.Signum.SIGKILL" /> and <see cref="F:Mono.Unix.Native.Signum.SIGSTOP" /> signals, the <c>signal</c>() function allows for a signal to be caught, to be ignored, or to generate an interrupt.
2908 <para>The <paramref name="sig" /> argument specifies which signal was received. The <paramref name="func" /> procedure allows a user to choose the action upon receipt of a signal. To set the default action of the signal to occur as listed above, <paramref name="func" /> should be <see cref="F:Mono.Unix.Native.Stdlib.SIG_DFL" />. A <see cref="F:Mono.Unix.Native.Stdlib.SIG_DFL" /> resets the default action. To ignore the signal func should be <see cref="F:Mono.Unix.Native.Stdlib.SIG_IGN" />. This will cause subsequent instances of the signal to be ignored and pending instances to be discarded. If <see cref="F:Mono.Unix.Native.Stdlib.SIG_IGN" /> is not used, further occurrences of the signal are automatically blocked and <paramref name="func" /> is called.
2910 <para>The handled signal is unblocked when the function returns and the process continues from where it left off when the signal occurred.
2912 <para>For some system calls, if a signal is caught while the call is executing and the call is prematurely terminated, the call is automatically restarted. (The handler is installed using the SA_RESTART flag with <see cref="M:Mono.Unix.Native.Syscall.sigaction" />(2).) The affected system calls include <see cref="M:Mono.Unix.Native.Syscall.read" />(2), <see cref="M:Mono.Unix.Native.Syscall.write" />(2), <see cref="M:Mono.Unix.Native.Syscall.sendto" />(2), <see cref="M:Mono.Unix.Native.Syscall.recvfrom" />(2), <see cref="M:Mono.Unix.Native.Syscall.sendmsg" />(2) and <see cref="M:Mono.Unix.Native.Syscall.recvmsg" />(2) on a communications channel or a low speed device and during a <see cref="M:Mono.Unix.Native.Syscall.ioctl" />(2) or <see cref="M:Mono.Unix.Native.Syscall.wait" />(2). However, calls that have already committed are not restarted, but instead return a partial success (for example, a short read count). These semantics could be changed with <see cref="M:Mono.Unix.Native.Syscall.siginterrupt" />(3)
2914 <para>When a process which has installed signal handlers forks, the child process inherits the signals. All caught signals may be reset to their default action by a call to the <see cref="M:Mono.Unix.Native.Syscall.execve" />(2) function; ignored signals remain ignored.
2916 <para>If a process explicitly specifies <see cref="F:Mono.Unix.Native.Stdlib.SIG_IGN" /> as the action for the signal <see cref="F:Mono.Unix.Native.Stdlib.SIGCHLD" />, the system will not create zombie processes when children of the calling process exit. As a consequence, the system will discard the exit status from the child processes. If the calling process subsequently issues a call to <see cref="M:Mono.Unix.Native.Syscall.wait" />(2) or equivalent, it will block until all of the calling process's children terminate, and then return a value of -1 with <see cref="M:Mono.Unix.Native.Stdlib.GetLastError" /> returning <see cref="F:Mono.Unix.Native.Errno.ECHILD" />.
2919 <altmember cref="M:Mono.Unix.Native.Stdlib.SetSignalAction" />
2920 <altmember cref="T:Mono.Unix.UnixSignal" />
2923 <Member MemberName="snprintf">
2924 <MemberSignature Language="C#" Value="public static int snprintf (System.Text.StringBuilder s, string message);" />
2925 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 snprintf(class System.Text.StringBuilder s, string message) cil managed" />
2926 <MemberType>Method</MemberType>
2928 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2929 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2930 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2933 <ReturnType>System.Int32</ReturnType>
2936 <Parameter Name="s" Type="System.Text.StringBuilder" />
2937 <Parameter Name="message" Type="System.String" />
2940 <param name="s">The buffer to print the message into.</param>
2941 <param name="message">The message to print.</param>
2942 <summary>Print a string into a buffer.</summary>
2943 <returns>Returns the number of characters printed or the number of characters that would have been printed if the <paramref name="size" /> were unlimited (again, not including the final '<c>\0</c>').</returns>
2944 <remarks>The <c>snprintf</c> function will fill at most <see cref="P:System.Text.StringBuilder.Capacity" /> characters of the input buffer with the string <paramref name="message" />.</remarks>
2947 <Member MemberName="snprintf">
2948 <MemberSignature Language="C#" Value="public static int snprintf (System.Text.StringBuilder s, string format, object[] parameters);" />
2949 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 snprintf(class System.Text.StringBuilder s, string format, object[] parameters) cil managed" />
2950 <MemberType>Method</MemberType>
2952 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
2953 <AssemblyVersion>2.0.0.0</AssemblyVersion>
2954 <AssemblyVersion>4.0.0.0</AssemblyVersion>
2958 <AttributeName>System.CLSCompliant(false)</AttributeName>
2961 <AttributeName>System.Obsolete("Not necessarily portable due to cdecl restrictions.
2962 Use snprintf (StringBuilder, string) instead.")</AttributeName>
2966 <ReturnType>System.Int32</ReturnType>
2969 <Parameter Name="s" Type="System.Text.StringBuilder" />
2970 <Parameter Name="format" Type="System.String" />
2971 <Parameter Name="parameters" Type="System.Object[]">
2974 <AttributeName>System.ParamArray</AttributeName>
2980 <param name="s">The buffer to print the message into.</param>
2981 <param name="format">The message format string.</param>
2982 <param name="parameters">Arguments for the message format string.</param>
2983 <summary>Print a string into a buffer.</summary>
2984 <returns>Returns the number of characters printed or the number of characters that would have been printed if the <paramref name="size" /> were unlimited (again, not including the final '<c>\0</c>').</returns>
2986 <para>The <c>snprintf</c>() family of functions produces output according to a format as described below. <c>snprintf</c>() writes output to the given output <paramref name="stream" />.</para>
2987 <para>These functions write the output under the control of a <paramref name="format" /> string that specifies how subsequent arguments (or arguments accessed via the variable-length argument facilities of <c>stdarg</c>(3)) are converted for output.
2989 <para>The format string is composed of zero or more directives: ordinary characters (not %), which are copied unchanged to the output stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments. Each conversion specification is introduced by the % character. The arguments must correspond properly (after type promotion) with the conversion specifier. After the %, the following appear in sequence:</para>
2990 <list type="bullet">
2992 <term>An optional field, consisting of a decimal digit string followed by a <c>$</c>, specifying the next argument to access. If this field is not provided, the argument following the last argument accessed will be used. Arguments are numbered starting at <c>1</c>. If unaccessed arguments in the format string are interspersed with ones that are accessed the results will be indeterminate.</term>
2995 <term>Zero or more of the following flags:
2997 <list type="table"><listheader><term>Flag</term><description>Description</description></listheader><item><term>'<c>#</c>'</term><description>The value should be converted to an "alternate form". For <c>c</c>, <c>d</c>, <c>i</c>, <c>n</c>, <c>p</c>, <c>s</c>, and <c>u</c> conversions, this option has no effect. For <c>o</c> conversions, the precision of the number is increased to force the first character of the output string to a zero (except if a zero value is printed with an explicit precision of zero). For <c>x</c> and <c>X</c> conversions, a non-zero result has the string '<c>0x</c>' (or '<c>0X</c>' for <c>X</c> conversions) prepended to it. For <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, and <c>G</c> conversions, the result will always contain a decimal point, even if no digits follow it (normally, a decimal point appears in the results of those conversions only if a digit follows). For <c>g</c> and <c>G</c> conversions, trailing zeros are not removed from the result as they would otherwise be.</description></item><item><term>'<c>0</c>' (zero)</term><description>Zero padding. For all conversions except <c>n</c>, the converted value is padded on the left with zeros rather than blanks. If a precision is given with a numeric conversion (<c>d</c>, <c>i</c>, <c>o</c>, <c>u</c>, <c>i</c>, <c>x</c>, and <c>X</c>), the 0 flag is ignored.</description></item><item><term>'<c>-</c>'</term><description>A negative field width flag; the converted value is to be left adjusted on the field boundary. Except for <c>n</c> conversions, the converted value is padded on the right with blanks, rather than on the left with blanks or zeros. A <c>-</c> overrides a <c>0</c> if both are given.</description></item><item><term>'<c />' (space)</term><description>A blank should be left before a positive number produced by a signed conversion (<c>a</c>, <c>A</c>, <c>d</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, <c>G</c>, or <c>i</c>).</description></item><item><term>'<c>+</c>'</term><description>A sign must always be placed before a number produced by a signed conversion. A <c>+</c> overrides a space if both are used.</description></item><item><term>'<c>'</c>'</term><description>Decimal conversions (<c>d</c>, <c>u</c>, or <c>i</c>) or the integral portion of a floating point conversion (<c>f</c> or <c>F</c>) should be grouped and separated by thousands using the non-monetary separator returned by <see cref="M:Mono.Unix.Native.Syscall.localeconv" />(3).</description></item></list></term>
3000 <term>An optional decimal digit string specifying a minimum field width. If the converted value has fewer characters than the field width, it will be padded with spaces on the left (or right, if the left-adjustment flag has been given) to fill out the field width.</term>
3003 <term>An optional precision, in the form of a period . followed by an optional digit string. If the digit string is omitted, the precision is taken as zero. This gives the minimum number of digits to appear for <c>d</c>, <c>i</c>, <c>o</c>, <c>u</c>, <c>x</c>, and <c>X</c> conversions, the number of digits to appear after the decimal-point for <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, and <c>F</c> conversions, the maximum number of significant digits for <c>g</c> and <c>G</c> conversions, or the maximum number of characters to be printed from a string for <c>s</c> conversions.</term>
3006 <term>An optional length modifier, that specifies the size of the argument. The following length modifiers are valid for the <c>d</c>, <c>i</c>, <c>n</c>, <c>o</c>, <c>u</c>, <c>x</c>, or <c>X</c> conversion:
3008 <list type="table"><listheader><term>Modifier</term><description><c>d</c>, <c>i</c></description><description><c>o, u, x, X</c></description><description><c>n</c></description></listheader><item><term><c>hh</c></term><description><c>signed char</c></description><description><c>unsigned char</c></description><description><c>signed char *</c></description></item><item><term><c>h</c></term><description><c>short</c></description><description><c>unsigned short</c></description><description><c>short *</c></description></item><item><term><c>l</c> (ell)</term><description><c>long</c></description><description><c>unsigned long</c></description><description><c>unsigned long *</c></description></item><item><term><c>ll</c> (ell ell)</term><description><c>long long</c></description><description><c>unsigned long long</c></description><description><c>long long *</c></description></item><item><term><c>j</c></term><description><c>intmax_t</c></description><description><c>uintmax_t</c></description><description><c>intmax_t *</c></description></item><item><term><c>t</c></term><description><c>ptrdiff_t</c></description><description>(see note)</description><description><c>ptrdiff_t *</c></description></item><item><term><c>z</c></term><description>(see note)</description><description><c>size_t</c></description><description>(see note)</description></item><item><term><c>q</c><i>(deprecated)</i></term><description><c>quad_t</c></description><description><c>u_quad_t</c></description><description><c>quad_t *</c></description></item></list><block subset="none" type="note"><para>the <c>t</c> modifier, when applied to a <c>o</c>, <c>u</c>, <c>x</c>, or <c>X</c> conversion, indicates that the argument is of an unsigned type equivalent in size to a <c>ptrdiff_t</c>. The <c>z</c> modifier, when applied to a <c>d</c> or <c>i</c> conversion, indicates that the argument is of a signed type equivalent in size to a <c>size_t</c>. Similarly, when applied to an <c>n</c> conversion, it indicates that the argument is a pointer to a signed type equivalent in size to a <c>size_t</c>.
3009 </para></block><para>The following length modifier is valid for the <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, or <c>G</c> conversion:</para><list type="table"><listheader><term>Modifier</term><description><c>a, A, e, E, f, F, g, G</c></description></listheader><item><term><c>L</c></term><description><c>long double</c></description></item></list><para>The following length modifier is valid for the <c>c</c> or <c>s</c> conversion:</para><list type="table"><listheader><term>Modifier</term><description><c>c</c></description><description><c>s</c></description></listheader><item><term><c>l</c> (ell)</term><description><c>wint_t</c></description><description><c>wchar_t *</c></description></item></list></term>
3012 <term>A character that specifies the type of conversion to be applied.</term>
3015 <para>A field width or precision, or both, may be indicated by an asterisk '<c>*</c>' or an asterisk followed by one or more decimal digits and a '<c>$</c>' instead of a digit string. In this case, an <i>int</i> argument supplies the field width or precision. A negative field width is treated as a left adjustment flag followed by a positive field width; a negative precision is treated as though it were missing. If a single format directive mixes positional (<c>nn$</c>) and non-positional arguments, the results are undefined
3017 <para>The conversion specifiers and their meanings are:</para>
3020 <term>Specifier</term>
3021 <description>Meaning</description>
3027 <description>The <c>int</c> (or appropriate variant) argument is converted to signed decimal (<c>d</c> and <c>i</c>), unsigned octal (<c>o</c>), unsigned decimal (<c>u</c>), or unsigned hexadecimal (<c>x</c> and <c>X</c>) notation. The letters "<c>abcdef</c>" are used for <c>x</c> conversions; the letters "<c>ABCDEF</c>" are used for <c>X</c> conversions. The precision, if any, gives the minimum number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with zeros.</description>
3033 <description>The <c>long int</c> argument is converted to signed decimal, unsigned octal, or unsigned decimal, as if the format had been <c>ld</c>, <c>lo</c>, or <c>lu</c> respectively. These conversion characters are deprecated, and will eventually disappear.</description>
3039 <description>The <c>double</c> argument is rounded and converted in the style <c>[-]d.ddde±dd</c> where there is one digit before the decimal-point character and the number of digits after it is equal to the precision; if the precision is missing, it is taken as 6; if the precision is zero, no decimal-point character appears. An <c>E</c> conversion uses the letter '<c>E</c>' (rather than '<c>e</c>') to introduce the exponent. The exponent always contains at least two digits; if the value is zero, the exponent is 00.</description>
3040 <para>For <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, and <c>G</c> conversions, positive and negative infinity are represented as <c>inf</c> and <c>-inf</c> respectively when using the lowercase conversion character, and <c>INF</c> and <c>-INF</c> respectively when using the uppercase conversion character. Similarly, <c>NaN</c> is represented as <c>nan</c> when using the lowercase conversion, and <c>NAN</c> when using the uppercase conversion.</para>
3046 <description>The <c>double</c> argument is rounded and converted to decimal notation in the style <c>[-]ddd.ddd</c>, where the number of digits after the decimal-point character is equal to the precision specification. If the precision is missing, it is taken as 6; if the precision is explicitly zero, no decimal-point character appears. If a decimal point appears, at least one digit appears before it.</description>
3052 <description>The <c>double</c> argument is converted in style <c>f</c> or <c>e</c> (or <c>F</c> or <c>E</c> for <c>G</c> conversions). The precision specifies the number of significant digits. If the precision is missing, 6 digits are given; if the precision is zero, it is treated as 1. Style <c>e</c> is used if the exponent from its conversion is less than -4 or greater than or equal to the precision. Trailing zeros are removed from the fractional part of the result; a decimal point appears only if it is followed by at least one digit.</description>
3058 <description>The <c>double</c> argument is rounded and converted to hexadecimal notation in the style <c>[-]0xh.hhhp[±]d</c>, where the number of digits after the hexadecimal-point character is equal to the precision specification. If the precision is missing, it is taken as enough to represent the floating-point number exactly, and no rounding occurs. If the precision is zero, no hexadecimal-point character appears. The <c>p</c> is a literal character '<c>p</c>', and the exponent consists of a positive or negative sign followed by a decimal number representing an exponent of 2. The <c>A</c> conversion uses the prefix "<c>0X</c>" (rather than "<c>0x</c>"), the letters "<c>ABCDEF</c>" (rather than "<c>abcdef</c>") to represent the hex digits, and the letter '<c>P</c>' (rather than '<c>p</c>') to separate the mantissa and exponent.
3060 <para>Note that there may be multiple valid ways to represent floating-point numbers in this hexadecimal format. For example, <c>0x3.24p+0</c>, <c>0x6.48p-1</c> and <c>0xc.9p-2</c> are all equivalent. The format chosen depends on the internal representation of the number, but the implementation guarantees that the length of the mantissa will be minimized. Zeroes are always represented with a mantissa of 0 (preceded by a '<c>-</c>' if appropriate) and an exponent of +0.
3061 </para></description>
3067 <description>Treated as <c>c</c> with the <c>l</c> (ell) modifier.</description>
3073 <description>The <c>int</c> argument is converted to an <c>unsigned char</c>, and the resulting character is written.
3075 <para>If the <c>l</c> (ell) modifier is used, the <c>wint_t</c> argument shall be converted to a <c>wchar_t</c>, and the (potentially multi-byte) sequence representing the single wide character is written, including any shift sequences. If a shift sequence is used, the shift state is also restored to the original state after the character.
3076 </para></description>
3082 <description>Treated as <c>s</c> with the <c>l</c> (ell) modifier.</description>
3089 The <c>char *</c> argument is expected to be a pointer to an array of character type (pointer to a string). Characters from the array are written up to (but not including) a terminating NUL character; if a precision is specified, no more than the number specified are written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the size of the array, the array must contain a terminating NUL character.
3091 <para>If the <c>l</c> (ell) modifier is used, the <c>wchar_t *</c> argument is expected to be a pointer to an array of wide characters (pointer to a wide string). For each wide character in the string, the (potentially multi-byte) sequence representing the wide character is written, including any shift sequences. If any shift sequence is used, the shift state is also restored to the original state after the string. Wide characters from the array are written up to (but not including) a terminating wide NUL character; if a precision is specified, no more than the number of bytes specified are written (including shift sequences). Partial characters are never written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the number of bytes required to render the multibyte representation of the string, the array must contain a terminating wide NUL character.</para></description>
3097 <description>The <c>void *</c> pointer argument is printed in hexadecimal (as if by '<c>%#x</c>' or '<c>%#lx</c>').</description>
3103 <description>The number of characters written so far is stored into the integer indicated by the <c>int *</c> (or variant) pointer argument. No argument is converted.</description>
3109 <description> A '<c>%</c>' is written. No argument is converted. The complete conversion specification is '<c>%%</c>'.</description>
3112 <para>The decimal point character is defined in the program's locale (category <c>LC_NUMERIC</c>)
3114 <para>In no case does a non-existent or small field width cause truncation of a numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result.</para>
3118 <Member MemberName="snprintf">
3119 <MemberSignature Language="C#" Value="public static int snprintf (System.Text.StringBuilder s, ulong n, string message);" />
3120 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 snprintf(class System.Text.StringBuilder s, unsigned int64 n, string message) cil managed" />
3121 <MemberType>Method</MemberType>
3123 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3124 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3125 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3129 <AttributeName>System.CLSCompliant(false)</AttributeName>
3133 <ReturnType>System.Int32</ReturnType>
3136 <Parameter Name="s" Type="System.Text.StringBuilder" />
3137 <Parameter Name="n" Type="System.UInt64" />
3138 <Parameter Name="message" Type="System.String" />
3141 <param name="s">The buffer to print the message into.</param>
3142 <param name="n">The size of the buffer.</param>
3143 <param name="message">The message to print.</param>
3144 <summary>Print a string into a buffer.</summary>
3145 <returns>Returns the number of characters printed or the number of characters that would have been printed if the <paramref name="size" /> were unlimited (again, not including the final '<c>\0</c>').</returns>
3146 <remarks>The <c>snprintf</c> function will fill at most <paramref name="n" /> characters of the input buffer with the string <paramref name="message" />.</remarks>
3149 <Member MemberName="snprintf">
3150 <MemberSignature Language="C#" Value="public static int snprintf (System.Text.StringBuilder s, ulong n, string format, object[] parameters);" />
3151 <MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 snprintf(class System.Text.StringBuilder s, unsigned int64 n, string format, object[] parameters) cil managed" />
3152 <MemberType>Method</MemberType>
3154 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3155 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3156 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3160 <AttributeName>System.CLSCompliant(false)</AttributeName>
3163 <AttributeName>System.Obsolete("Not necessarily portable due to cdecl restrictions.
3164 Use snprintf (StringBuilder, string) instead.")</AttributeName>
3168 <ReturnType>System.Int32</ReturnType>
3171 <Parameter Name="s" Type="System.Text.StringBuilder" />
3172 <Parameter Name="n" Type="System.UInt64" />
3173 <Parameter Name="format" Type="System.String" />
3174 <Parameter Name="parameters" Type="System.Object[]">
3177 <AttributeName>System.ParamArray</AttributeName>
3183 <param name="s">The buffer to print the message into.</param>
3184 <param name="n">The size of the buffer.</param>
3185 <param name="format">The message format string.</param>
3186 <param name="parameters">Arguments for the message format string.</param>
3187 <summary>Print a string into a buffer.</summary>
3188 <returns>Returns the number of characters printed or the number of characters that would have been printed if the <paramref name="size" /> were unlimited (again, not including the final '<c>\0</c>').</returns>
3190 <para>The <c>snprintf</c>() family of functions produces output according to a format as described below. <c>snprintf</c>() writes output to the given output <paramref name="stream" />.</para>
3191 <para>These functions write the output under the control of a <paramref name="format" /> string that specifies how subsequent arguments (or arguments accessed via the variable-length argument facilities of <c>stdarg</c>(3)) are converted for output.
3193 <para>The format string is composed of zero or more directives: ordinary characters (not %), which are copied unchanged to the output stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments. Each conversion specification is introduced by the % character. The arguments must correspond properly (after type promotion) with the conversion specifier. After the %, the following appear in sequence:</para>
3194 <list type="bullet">
3196 <term>An optional field, consisting of a decimal digit string followed by a <c>$</c>, specifying the next argument to access. If this field is not provided, the argument following the last argument accessed will be used. Arguments are numbered starting at <c>1</c>. If unaccessed arguments in the format string are interspersed with ones that are accessed the results will be indeterminate.</term>
3199 <term>Zero or more of the following flags:
3201 <list type="table"><listheader><term>Flag</term><description>Description</description></listheader><item><term>'<c>#</c>'</term><description>The value should be converted to an "alternate form". For <c>c</c>, <c>d</c>, <c>i</c>, <c>n</c>, <c>p</c>, <c>s</c>, and <c>u</c> conversions, this option has no effect. For <c>o</c> conversions, the precision of the number is increased to force the first character of the output string to a zero (except if a zero value is printed with an explicit precision of zero). For <c>x</c> and <c>X</c> conversions, a non-zero result has the string '<c>0x</c>' (or '<c>0X</c>' for <c>X</c> conversions) prepended to it. For <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, and <c>G</c> conversions, the result will always contain a decimal point, even if no digits follow it (normally, a decimal point appears in the results of those conversions only if a digit follows). For <c>g</c> and <c>G</c> conversions, trailing zeros are not removed from the result as they would otherwise be.</description></item><item><term>'<c>0</c>' (zero)</term><description>Zero padding. For all conversions except <c>n</c>, the converted value is padded on the left with zeros rather than blanks. If a precision is given with a numeric conversion (<c>d</c>, <c>i</c>, <c>o</c>, <c>u</c>, <c>i</c>, <c>x</c>, and <c>X</c>), the 0 flag is ignored.</description></item><item><term>'<c>-</c>'</term><description>A negative field width flag; the converted value is to be left adjusted on the field boundary. Except for <c>n</c> conversions, the converted value is padded on the right with blanks, rather than on the left with blanks or zeros. A <c>-</c> overrides a <c>0</c> if both are given.</description></item><item><term>'<c />' (space)</term><description>A blank should be left before a positive number produced by a signed conversion (<c>a</c>, <c>A</c>, <c>d</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, <c>G</c>, or <c>i</c>).</description></item><item><term>'<c>+</c>'</term><description>A sign must always be placed before a number produced by a signed conversion. A <c>+</c> overrides a space if both are used.</description></item><item><term>'<c>'</c>'</term><description>Decimal conversions (<c>d</c>, <c>u</c>, or <c>i</c>) or the integral portion of a floating point conversion (<c>f</c> or <c>F</c>) should be grouped and separated by thousands using the non-monetary separator returned by <see cref="M:Mono.Unix.Native.Syscall.localeconv" />(3).</description></item></list></term>
3204 <term>An optional decimal digit string specifying a minimum field width. If the converted value has fewer characters than the field width, it will be padded with spaces on the left (or right, if the left-adjustment flag has been given) to fill out the field width.</term>
3207 <term>An optional precision, in the form of a period . followed by an optional digit string. If the digit string is omitted, the precision is taken as zero. This gives the minimum number of digits to appear for <c>d</c>, <c>i</c>, <c>o</c>, <c>u</c>, <c>x</c>, and <c>X</c> conversions, the number of digits to appear after the decimal-point for <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, and <c>F</c> conversions, the maximum number of significant digits for <c>g</c> and <c>G</c> conversions, or the maximum number of characters to be printed from a string for <c>s</c> conversions.</term>
3210 <term>An optional length modifier, that specifies the size of the argument. The following length modifiers are valid for the <c>d</c>, <c>i</c>, <c>n</c>, <c>o</c>, <c>u</c>, <c>x</c>, or <c>X</c> conversion:
3212 <list type="table"><listheader><term>Modifier</term><description><c>d</c>, <c>i</c></description><description><c>o, u, x, X</c></description><description><c>n</c></description></listheader><item><term><c>hh</c></term><description><c>signed char</c></description><description><c>unsigned char</c></description><description><c>signed char *</c></description></item><item><term><c>h</c></term><description><c>short</c></description><description><c>unsigned short</c></description><description><c>short *</c></description></item><item><term><c>l</c> (ell)</term><description><c>long</c></description><description><c>unsigned long</c></description><description><c>unsigned long *</c></description></item><item><term><c>ll</c> (ell ell)</term><description><c>long long</c></description><description><c>unsigned long long</c></description><description><c>long long *</c></description></item><item><term><c>j</c></term><description><c>intmax_t</c></description><description><c>uintmax_t</c></description><description><c>intmax_t *</c></description></item><item><term><c>t</c></term><description><c>ptrdiff_t</c></description><description>(see note)</description><description><c>ptrdiff_t *</c></description></item><item><term><c>z</c></term><description>(see note)</description><description><c>size_t</c></description><description>(see note)</description></item><item><term><c>q</c><i>(deprecated)</i></term><description><c>quad_t</c></description><description><c>u_quad_t</c></description><description><c>quad_t *</c></description></item></list><block subset="none" type="note"><para>the <c>t</c> modifier, when applied to a <c>o</c>, <c>u</c>, <c>x</c>, or <c>X</c> conversion, indicates that the argument is of an unsigned type equivalent in size to a <c>ptrdiff_t</c>. The <c>z</c> modifier, when applied to a <c>d</c> or <c>i</c> conversion, indicates that the argument is of a signed type equivalent in size to a <c>size_t</c>. Similarly, when applied to an <c>n</c> conversion, it indicates that the argument is a pointer to a signed type equivalent in size to a <c>size_t</c>.
3213 </para></block><para>The following length modifier is valid for the <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, or <c>G</c> conversion:</para><list type="table"><listheader><term>Modifier</term><description><c>a, A, e, E, f, F, g, G</c></description></listheader><item><term><c>L</c></term><description><c>long double</c></description></item></list><para>The following length modifier is valid for the <c>c</c> or <c>s</c> conversion:</para><list type="table"><listheader><term>Modifier</term><description><c>c</c></description><description><c>s</c></description></listheader><item><term><c>l</c> (ell)</term><description><c>wint_t</c></description><description><c>wchar_t *</c></description></item></list></term>
3216 <term>A character that specifies the type of conversion to be applied.</term>
3219 <para>A field width or precision, or both, may be indicated by an asterisk '<c>*</c>' or an asterisk followed by one or more decimal digits and a '<c>$</c>' instead of a digit string. In this case, an <i>int</i> argument supplies the field width or precision. A negative field width is treated as a left adjustment flag followed by a positive field width; a negative precision is treated as though it were missing. If a single format directive mixes positional (<c>nn$</c>) and non-positional arguments, the results are undefined
3221 <para>The conversion specifiers and their meanings are:</para>
3224 <term>Specifier</term>
3225 <description>Meaning</description>
3231 <description>The <c>int</c> (or appropriate variant) argument is converted to signed decimal (<c>d</c> and <c>i</c>), unsigned octal (<c>o</c>), unsigned decimal (<c>u</c>), or unsigned hexadecimal (<c>x</c> and <c>X</c>) notation. The letters "<c>abcdef</c>" are used for <c>x</c> conversions; the letters "<c>ABCDEF</c>" are used for <c>X</c> conversions. The precision, if any, gives the minimum number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with zeros.</description>
3237 <description>The <c>long int</c> argument is converted to signed decimal, unsigned octal, or unsigned decimal, as if the format had been <c>ld</c>, <c>lo</c>, or <c>lu</c> respectively. These conversion characters are deprecated, and will eventually disappear.</description>
3243 <description>The <c>double</c> argument is rounded and converted in the style <c>[-]d.ddde±dd</c> where there is one digit before the decimal-point character and the number of digits after it is equal to the precision; if the precision is missing, it is taken as 6; if the precision is zero, no decimal-point character appears. An <c>E</c> conversion uses the letter '<c>E</c>' (rather than '<c>e</c>') to introduce the exponent. The exponent always contains at least two digits; if the value is zero, the exponent is 00.</description>
3244 <para>For <c>a</c>, <c>A</c>, <c>e</c>, <c>E</c>, <c>f</c>, <c>F</c>, <c>g</c>, and <c>G</c> conversions, positive and negative infinity are represented as <c>inf</c> and <c>-inf</c> respectively when using the lowercase conversion character, and <c>INF</c> and <c>-INF</c> respectively when using the uppercase conversion character. Similarly, <c>NaN</c> is represented as <c>nan</c> when using the lowercase conversion, and <c>NAN</c> when using the uppercase conversion.</para>
3250 <description>The <c>double</c> argument is rounded and converted to decimal notation in the style <c>[-]ddd.ddd</c>, where the number of digits after the decimal-point character is equal to the precision specification. If the precision is missing, it is taken as 6; if the precision is explicitly zero, no decimal-point character appears. If a decimal point appears, at least one digit appears before it.</description>
3256 <description>The <c>double</c> argument is converted in style <c>f</c> or <c>e</c> (or <c>F</c> or <c>E</c> for <c>G</c> conversions). The precision specifies the number of significant digits. If the precision is missing, 6 digits are given; if the precision is zero, it is treated as 1. Style <c>e</c> is used if the exponent from its conversion is less than -4 or greater than or equal to the precision. Trailing zeros are removed from the fractional part of the result; a decimal point appears only if it is followed by at least one digit.</description>
3262 <description>The <c>double</c> argument is rounded and converted to hexadecimal notation in the style <c>[-]0xh.hhhp[±]d</c>, where the number of digits after the hexadecimal-point character is equal to the precision specification. If the precision is missing, it is taken as enough to represent the floating-point number exactly, and no rounding occurs. If the precision is zero, no hexadecimal-point character appears. The <c>p</c> is a literal character '<c>p</c>', and the exponent consists of a positive or negative sign followed by a decimal number representing an exponent of 2. The <c>A</c> conversion uses the prefix "<c>0X</c>" (rather than "<c>0x</c>"), the letters "<c>ABCDEF</c>" (rather than "<c>abcdef</c>") to represent the hex digits, and the letter '<c>P</c>' (rather than '<c>p</c>') to separate the mantissa and exponent.
3264 <para>Note that there may be multiple valid ways to represent floating-point numbers in this hexadecimal format. For example, <c>0x3.24p+0</c>, <c>0x6.48p-1</c> and <c>0xc.9p-2</c> are all equivalent. The format chosen depends on the internal representation of the number, but the implementation guarantees that the length of the mantissa will be minimized. Zeroes are always represented with a mantissa of 0 (preceded by a '<c>-</c>' if appropriate) and an exponent of +0.
3265 </para></description>
3271 <description>Treated as <c>c</c> with the <c>l</c> (ell) modifier.</description>
3277 <description>The <c>int</c> argument is converted to an <c>unsigned char</c>, and the resulting character is written.
3279 <para>If the <c>l</c> (ell) modifier is used, the <c>wint_t</c> argument shall be converted to a <c>wchar_t</c>, and the (potentially multi-byte) sequence representing the single wide character is written, including any shift sequences. If a shift sequence is used, the shift state is also restored to the original state after the character.
3280 </para></description>
3286 <description>Treated as <c>s</c> with the <c>l</c> (ell) modifier.</description>
3293 The <c>char *</c> argument is expected to be a pointer to an array of character type (pointer to a string). Characters from the array are written up to (but not including) a terminating NUL character; if a precision is specified, no more than the number specified are written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the size of the array, the array must contain a terminating NUL character.
3295 <para>If the <c>l</c> (ell) modifier is used, the <c>wchar_t *</c> argument is expected to be a pointer to an array of wide characters (pointer to a wide string). For each wide character in the string, the (potentially multi-byte) sequence representing the wide character is written, including any shift sequences. If any shift sequence is used, the shift state is also restored to the original state after the string. Wide characters from the array are written up to (but not including) a terminating wide NUL character; if a precision is specified, no more than the number of bytes specified are written (including shift sequences). Partial characters are never written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the number of bytes required to render the multibyte representation of the string, the array must contain a terminating wide NUL character.</para></description>
3301 <description>The <c>void *</c> pointer argument is printed in hexadecimal (as if by '<c>%#x</c>' or '<c>%#lx</c>').</description>
3307 <description>The number of characters written so far is stored into the integer indicated by the <c>int *</c> (or variant) pointer argument. No argument is converted.</description>
3313 <description> A '<c>%</c>' is written. No argument is converted. The complete conversion specification is '<c>%%</c>'.</description>
3316 <para>The decimal point character is defined in the program's locale (category <c>LC_NUMERIC</c>)
3318 <para>In no case does a non-existent or small field width cause truncation of a numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result.</para>
3322 <Member MemberName="srand">
3323 <MemberSignature Language="C#" Value="public static void srand (uint seed);" />
3324 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "srand" cdecl)void srand(unsigned int32 seed) cil managed" />
3325 <MemberType>Method</MemberType>
3327 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3328 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3329 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3333 <AttributeName>System.CLSCompliant(false)</AttributeName>
3337 <ReturnType>System.Void</ReturnType>
3340 <Parameter Name="seed" Type="System.UInt32" />
3343 <param name="seed">The value to seed the random number generator with.</param>
3344 <summary>Initialize the random number generator.</summary>
3346 <para>The <c>srand</c>() function sets its argument <paramref name="seed" /> as the seed for a new sequence of pseudo-random numbers to be returned by <see cref="M:Mono.Unix.Native.Stdlib.rand" />(). These sequences are repeatable by calling <c>srand</c>() with the same seed value.</para>
3347 <para>If no <paramref name="seed" /> value is provided, the functions are automatically seeded with a value of 1.</para>
3351 <Member MemberName="stderr">
3352 <MemberSignature Language="C#" Value="public static readonly IntPtr stderr;" />
3353 <MemberSignature Language="ILAsm" Value=".field public static initonly native int stderr" />
3354 <MemberType>Field</MemberType>
3356 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3357 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3358 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3361 <ReturnType>System.IntPtr</ReturnType>
3364 <summary>Standard error <c>FILE</c> stream.</summary>
3365 <remarks>To be added.</remarks>
3368 <Member MemberName="stdin">
3369 <MemberSignature Language="C#" Value="public static readonly IntPtr stdin;" />
3370 <MemberSignature Language="ILAsm" Value=".field public static initonly native int stdin" />
3371 <MemberType>Field</MemberType>
3373 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3374 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3375 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3378 <ReturnType>System.IntPtr</ReturnType>
3381 <summary>Standard input <c>FILE</c> stream.</summary>
3382 <remarks>To be added.</remarks>
3385 <Member MemberName="stdout">
3386 <MemberSignature Language="C#" Value="public static readonly IntPtr stdout;" />
3387 <MemberSignature Language="ILAsm" Value=".field public static initonly native int stdout" />
3388 <MemberType>Field</MemberType>
3390 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3391 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3392 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3395 <ReturnType>System.IntPtr</ReturnType>
3398 <summary>Standard output <c>FILE</c> stream.</summary>
3399 <remarks>To be added.</remarks>
3402 <Member MemberName="strerror">
3403 <MemberSignature Language="C#" Value="public static string strerror (Mono.Unix.Native.Errno errnum);" />
3404 <MemberSignature Language="ILAsm" Value=".method public static hidebysig string strerror(valuetype Mono.Unix.Native.Errno errnum) cil managed" />
3405 <MemberType>Method</MemberType>
3407 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3408 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3409 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3413 <AttributeName>System.CLSCompliant(false)</AttributeName>
3417 <ReturnType>System.String</ReturnType>
3420 <Parameter Name="errnum" Type="Mono.Unix.Native.Errno" />
3423 <param name="errnum">Error number to get a message for.</param>
3424 <summary>Get error message string for 'errnum'.</summary>
3425 <returns>A string describing <paramref name="errnum" />.</returns>
3427 <para>The strerror() function accepts an error number argument errnum and returns a pointer to the corresponding message string.</para>
3428 <para>If the error number is not recognized, these functions return an error message string containing "<c>Unknown error: </c>" followed by the error number in decimal.
3433 <Member MemberName="strlen">
3434 <MemberSignature Language="C#" Value="public static ulong strlen (IntPtr s);" />
3435 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("MonoPosixHelper" as "Mono_Posix_Stdlib_strlen" cdecl lasterr)unsigned int64 strlen(native int s) cil managed" />
3436 <MemberType>Method</MemberType>
3438 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3439 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3440 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3444 <AttributeName>System.CLSCompliant(false)</AttributeName>
3448 <ReturnType>System.UInt64</ReturnType>
3451 <Parameter Name="s" Type="System.IntPtr" />
3454 <param name="s">To be added.</param>
3455 <summary>To be added.</summary>
3456 <returns>To be added.</returns>
3457 <remarks>To be added.</remarks>
3460 <Member MemberName="system">
3461 <MemberSignature Language="C#" Value="public static int system (string string);" />
3462 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "system" cdecl lasterr)int32 system(string string) cil managed" />
3463 <MemberType>Method</MemberType>
3465 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3466 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3467 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3471 <AttributeName>System.CLSCompliant(false)</AttributeName>
3475 <ReturnType>System.Int32</ReturnType>
3478 <Parameter Name="string" Type="System.String" />
3481 <param name="string">The command to execute.</param>
3482 <summary>Pass a command to the shell.</summary>
3484 <para>If <paramref name="string" /> is <see langword="null" />, <c>system</c> will return a non-zero value if the command interpreter <c>sh</c>(1) is available, and zero if it is not.</para>
3485 <para>Otherwise, the <c>system</c> function returns the exit status of the shell as returned by <see cref="M:Mono.Unix.Native.Syscall.waitpid" />(2), or -1 if an error occurred when invoking <see cref="M:Mono.Unix.Native.Syscall.fork" />(2) or <see cref="M:Mono.Unix.Native.Syscall.waitpid" />(2). A return value of 127 means the execution of the shell failed.
3488 <remarks>The <c>system</c>() function hands the argument <paramref name="string" /> to the command interpreter <c>sh</c>(1). The calling process waits for the shell to finish executing the command, ignoring <see cref="F:Mono.Unix.Native.Signum.SIGINT" /> and <see cref="F:Mono.Unix.Native.Signum.SIGQUIT" />, and blocking <see cref="F:Mono.Unix.Native.Signum.SIGCHLD" />.</remarks>
3491 <Member MemberName="TMP_MAX">
3492 <MemberSignature Language="C#" Value="public static readonly int TMP_MAX;" />
3493 <MemberSignature Language="ILAsm" Value=".field public static initonly int32 TMP_MAX" />
3494 <MemberType>Field</MemberType>
3496 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3497 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3498 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3502 <AttributeName>System.CLSCompliant(false)</AttributeName>
3506 <ReturnType>System.Int32</ReturnType>
3508 <MemberValue>238328</MemberValue>
3510 <summary>Maximum number of times <see cref="M:Mono.Unix.Native.Stdlib.tmpnam" />(3) will return different strings.</summary>
3511 <remarks>If <see cref="M:Mono.Unix.Native.Stdlib.tmpnam" />(3) is called more than <c>TMP_MAX</c> times, the behavior is implementation defined.</remarks>
3514 <Member MemberName="tmpfile">
3515 <MemberSignature Language="C#" Value="public static IntPtr tmpfile ();" />
3516 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "tmpfile" cdecl lasterr)native int tmpfile() cil managed" />
3517 <MemberType>Method</MemberType>
3519 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3520 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3521 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3524 <ReturnType>System.IntPtr</ReturnType>
3528 <summary>Create a temporary file.</summary>
3529 <returns>The <c>tmpfile</c>() function returns a pointer to an open file stream on success, and <see cref="F:System.IntPtr.Zero" /> on error.</returns>
3531 <para>The <c>tmpfile</c>() function returns a pointer to a stream associated with a file descriptor returned by the routine <see cref="M:Mono.Unix.Native.Syscall.mkstemp" />(3). The created file is unlinked before <c>tmpfile</c>() returns, causing the file to be automatically deleted when the last reference to it is closed. The file is opened with the access value '<c>w+</c>'. The file is created in the directory determined by the environment variable <c>TMPDIR</c> if set. The default location if <c>TMPDIR</c> is not set is <c>/tmp</c>.</para>
3536 <Member MemberName="tmpnam">
3537 <MemberSignature Language="C#" Value="public static string tmpnam ();" />
3538 <MemberSignature Language="ILAsm" Value=".method public static hidebysig string tmpnam() cil managed" />
3539 <MemberType>Method</MemberType>
3541 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3542 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3543 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3547 <AttributeName>System.Obsolete("Syscall.mkstemp() should be preferred.")</AttributeName>
3551 <ReturnType>System.String</ReturnType>
3555 <summary>Generate a temporary file name.</summary>
3556 <returns>Returns a file name on success, and <see langword="null" /> on error.</returns>
3557 <remarks>The <c>tmpnam</c>() function returns a pointer to a file name, in the <c>/tmp</c> directory, which did not reference an existing file at some indeterminate point in the past.</remarks>
3560 <Member MemberName="tmpnam">
3561 <MemberSignature Language="C#" Value="public static string tmpnam (System.Text.StringBuilder s);" />
3562 <MemberSignature Language="ILAsm" Value=".method public static hidebysig string tmpnam(class System.Text.StringBuilder s) cil managed" />
3563 <MemberType>Method</MemberType>
3565 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3566 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3567 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3571 <AttributeName>System.Obsolete("Syscall.mkstemp() should be preferred.")</AttributeName>
3575 <ReturnType>System.String</ReturnType>
3578 <Parameter Name="s" Type="System.Text.StringBuilder" />
3581 <param name="s">Buffer to store the temporary filename into</param>
3582 <summary>Generate a temporary file name.</summary>
3583 <returns>Returns a file name on success, and <see langword="null" /> on error.</returns>
3585 <para>The <c>tmpnam</c>() function returns a pointer to a file name, in the <c>/tmp</c> directory, which did not reference an existing file at some indeterminate point in the past. If the argument <paramref name="s" /> is not <see langword="null" />, the file name is copied into the buffer it references.</para>
3586 <para>The buffer referenced by <paramref name="s" /> is expected to be at least <see cref="F:Mono.Unix.Native.Stdlib.L_tmpnam" /> bytes in length.</para>
3590 <Member MemberName="ungetc">
3591 <MemberSignature Language="C#" Value="public static int ungetc (int c, IntPtr stream);" />
3592 <MemberSignature Language="ILAsm" Value=".method public static hidebysig pinvokeimpl ("msvcrt" as "ungetc" cdecl lasterr)int32 ungetc(int32 c, native int stream) cil managed" />
3593 <MemberType>Method</MemberType>
3595 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
3596 <AssemblyVersion>2.0.0.0</AssemblyVersion>
3597 <AssemblyVersion>4.0.0.0</AssemblyVersion>
3600 <ReturnType>System.Int32</ReturnType>
3603 <Parameter Name="c" Type="System.Int32" />
3604 <Parameter Name="stream" Type="System.IntPtr" />
3607 <param name="c">The character to unget.</param>
3608 <param name="stream">The <c>FILE</c> stream to unget <paramref name="c" /> on.</param>
3609 <summary>Un-get character from input <c>FILE</c> stream.</summary>
3610 <returns>The <c>ungetc</c>() function returns the character pushed-back after the conversion, or <see cref="F:Mono.Unix.Native.Stdlib.EOF" /> if the operation fails. If the value of the argument <paramref name="c" /> character equals <see cref="F:Mono.Unix.Native.Stdlib.EOF" />, the operation will fail and the stream will remain unchanged.</returns>
3612 <para>The <c>ungetc</c>() function pushes the character <paramref name="c" /> (converted to an unsigned char) back onto the input stream pointed to by <paramref name="stream" />. The pushed-back characters will be returned by subsequent reads on the stream (in reverse order). A successful intervening call, using the same stream, to one of the file positioning functions (<see cref="M:Mono.Unix.Native.Stdlib.fseek" />(3), <see cref="M:Mono.Unix.Native.Stdlib.fsetpos" />(3), or <see cref="M:Mono.Unix.Native.Stdlib.rewind" />(3)) will discard the pushed back characters.
3614 <para>One character of push-back is guaranteed, but as long as there is sufficient memory, an effectively infinite amount of pushback is allowed.
3616 <para>If a character is successfully pushed-back, the end-of-file indicator for the stream is cleared. The file-position indicator is decremented by each successful call to <c>ungetc</c>(); if its value was 0 before a call, its value is unspecified after the call.
projects / mono.git / blob