Include a header file required for build on mac 10.4
[supercollider.git] / Help / Files / UnixFILE.html
blob323f904ef61ce82d2c422114882147bd522cc24b
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta http-equiv="Content-Style-Type" content="text/css">
6 <title></title>
7 <meta name="Generator" content="Cocoa HTML Writer">
8 <meta name="CocoaVersion" content="824.42">
9 <style type="text/css">
10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Helvetica}
11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Courier}
14 span.s1 {color: #0000ff}
15 span.Apple-tab-span {white-space:pre}
16 </style>
17 </head>
18 <body>
19 <p class="p1"><b>UnixFILE</b></p>
20 <p class="p2"><br></p>
21 <p class="p3"><b>superclass: IOStream</b></p>
22 <p class="p2"><br></p>
23 <p class="p3"><b>An abstract class.<span class="Apple-converted-space">  </span>See </b><a href="File.html"><span class="s1"><b>File</b></span></a><b> and </b><a href="Pipe.html"><span class="s1"><b>Pipe</b></span></a></p>
24 <p class="p2"><br></p>
25 <p class="p2"><br></p>
26 <p class="p2"><br></p>
27 <p class="p3"><b>( docs incomplete )</b></p>
28 <p class="p2"><br></p>
29 <p class="p3"><b>isOpen</b></p>
30 <p class="p2"><br></p>
31 <p class="p3">returns whether the file is open. An open request can fail if a file cannot be found for example.<span class="Apple-converted-space"> </span></p>
32 <p class="p3">This method lets you test that the open call succeeded.</p>
33 <p class="p2"><br></p>
34 <p class="p2"><br></p>
35 <p class="p2"><br></p>
36 <p class="p3"><b>length</b></p>
37 <p class="p2"><br></p>
38 <p class="p3">Answer the length of the file.</p>
39 <p class="p2"><br></p>
40 <p class="p3"><b>pos</b></p>
41 <p class="p2"><br></p>
42 <p class="p3">Answer the current file position</p>
43 <p class="p2"><br></p>
44 <p class="p3"><b>seek(offset, origin)</b></p>
45 <p class="p2"><br></p>
46 <p class="p3">Seek to an offset from the origin.<span class="Apple-converted-space"> </span></p>
47 <p class="p3"><b>offset</b> - an offset in bytes.</p>
48 <p class="p3"><b>origin</b> - one of the following Integers:</p>
49 <p class="p2"><br></p>
50 <p class="p4"><span class="Apple-tab-span"> </span>0 - seek from beginning of file.</p>
51 <p class="p4"><span class="Apple-tab-span"> </span>1 - seek from current position in file.</p>
52 <p class="p4"><span class="Apple-tab-span"> </span>2 - seek from end of file.</p>
53 <p class="p2"><span class="Apple-tab-span"> </span></p>
54 <p class="p2"><br></p>
55 <p class="p2"><br></p>
56 <p class="p3"><b>write(item)</b></p>
57 <p class="p2"><br></p>
58 <p class="p3">Writes an item to the file.</p>
59 <p class="p3">item - one of the following:<span class="Apple-converted-space"> </span></p>
60 <p class="p3"><span class="Apple-tab-span"> </span>Float<span class="Apple-converted-space"> </span></p>
61 <p class="p3"><span class="Apple-tab-span"> </span>Integer,<span class="Apple-converted-space"> </span></p>
62 <p class="p3"><span class="Apple-tab-span"> </span>Char,<span class="Apple-converted-space"> </span></p>
63 <p class="p3"><span class="Apple-tab-span"> </span>Color,<span class="Apple-converted-space"> </span></p>
64 <p class="p3"><span class="Apple-tab-span"> </span>Symbol - writes the name of the Symbol as a C string.</p>
65 <p class="p3"><span class="Apple-tab-span"> </span>RawArray - write the bytes from any RawArray in big endian.</p>
66 <p class="p2"><br></p>
67 <p class="p2"><br></p>
68 <p class="p2"><br></p>
69 <p class="p2"><br></p>
70 <p class="p2"><br></p>
71 <p class="p3"><b>getLine</b></p>
72 <p class="p2"><br></p>
73 <p class="p3">Reads and returns a String up to lesser of next newline or 1023 chars.</p>
74 <p class="p2"><br></p>
75 <p class="p3"><b>getChar</b></p>
76 <p class="p2"><br></p>
77 <p class="p3">read one byte and return as a Char</p>
78 <p class="p2"><br></p>
79 <p class="p3"><b>getInt8</b></p>
80 <p class="p2"><br></p>
81 <p class="p3">read one byte and return as a Integer.</p>
82 <p class="p2"><br></p>
83 <p class="p3"><b>getInt16</b></p>
84 <p class="p2"><br></p>
85 <p class="p3">read two bytes and return as an Integer.</p>
86 <p class="p2"><br></p>
87 <p class="p3"><b>getInt32</b></p>
88 <p class="p2"><br></p>
89 <p class="p3">read four bytes and return as an Integer.</p>
90 <p class="p2"><br></p>
91 <p class="p3"><b>getFloat</b></p>
92 <p class="p2"><br></p>
93 <p class="p3">read four bytes and return as a Float.</p>
94 <p class="p2"><br></p>
95 <p class="p3"><b>getDouble</b></p>
96 <p class="p2"><br></p>
97 <p class="p3">read eight bytes and return as a Float.</p>
98 <p class="p2"><br></p>
99 <p class="p3"><b>putChar</b></p>
100 <p class="p2"><br></p>
101 <p class="p3">write a Char as one byte.</p>
102 <p class="p2"><br></p>
103 <p class="p3"><b>putInt8</b></p>
104 <p class="p2"><br></p>
105 <p class="p3">write an Integer as one byte.</p>
106 <p class="p2"><br></p>
107 <p class="p3"><b>putInt16</b></p>
108 <p class="p2"><br></p>
109 <p class="p3">write an Integer as two bytes.</p>
110 <p class="p2"><br></p>
111 <p class="p3"><b>putInt32</b></p>
112 <p class="p2"><br></p>
113 <p class="p3">write an Integer as four bytes.</p>
114 <p class="p2"><br></p>
115 <p class="p3"><b>putFloat</b></p>
116 <p class="p2"><br></p>
117 <p class="p3">write a Float as four bytes.</p>
118 <p class="p2"><br></p>
119 <p class="p3"><b>putDouble</b></p>
120 <p class="p2"><br></p>
121 <p class="p3">write a Float as eight bytes.</p>
122 <p class="p2"><br></p>
123 <p class="p3"><b>putString</b></p>
124 <p class="p2"><br></p>
125 <p class="p3">write a null terminated String.</p>
126 <p class="p2"><br></p>
127 <p class="p3"><b>readAllString</b></p>
128 <p class="p2"><br></p>
129 <p class="p3">Reads the entire file as a String.</p>
130 <p class="p2"><br></p>
131 <p class="p3"><b>readAllInt8</b></p>
132 <p class="p2"><br></p>
133 <p class="p3">Reads the entire file as an Int8Array.</p>
134 <p class="p2"><br></p>
135 <p class="p3"><b>readAllInt16</b></p>
136 <p class="p2"><br></p>
137 <p class="p3">Reads the entire file as an Int16Array.</p>
138 <p class="p2"><br></p>
139 <p class="p3"><b>readAllInt32</b></p>
140 <p class="p2"><br></p>
141 <p class="p3">Reads the entire file as an Int32Array.</p>
142 <p class="p2"><br></p>
143 <p class="p3"><b>readAllFloat</b></p>
144 <p class="p2"><br></p>
145 <p class="p3">Reads the entire file as an FloatArray.</p>
146 <p class="p2"><br></p>
147 <p class="p3"><b>readAllDouble</b></p>
148 <p class="p2"><br></p>
149 <p class="p3">Reads the entire file as an DoubleArray.</p>
150 </body>
151 </html>