Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
wisp
GitHub Repository: wisp/impinj-reader-app
Path: blob/master/Resources/taoframework-2.1.0/bin/Tao.PhysFs.xml
178 views
1
<?xml version="1.0"?>
2
<doc>
3
<assembly>
4
<name>Tao.PhysFs</name>
5
</assembly>
6
<members>
7
<member name="T:Tao.PhysFs.Fs">
8
<summary>
9
PhysFS bindings for .NET, implementing PhysFS 1.0.1 (http://icculus.org/physfs/).
10
</summary>
11
<remarks>
12
PhysicsFS is a library to provide abstract access to
13
various archives. It is intended for use in video games,
14
and the design was somewhat inspired by Quake 3's file
15
subsystem.
16
<p>More information can be found at the official website (http://icculus.org/physfs/).</p>
17
</remarks>
18
</member>
19
<member name="F:Tao.PhysFs.Fs.PHYSFS_NATIVE_LIBRARY">
20
<summary>
21
Specifies the PhysicsFS native library used in the bindings
22
</summary>
23
<remarks>
24
The Windows dll is specified here universally - note that
25
under Mono the non-windows native library can be mapped using
26
the ".config" file mechanism. Kudos to the Mono team for this
27
simple yet elegant solution.
28
</remarks>
29
</member>
30
<member name="F:Tao.PhysFs.Fs.CALLING_CONVENTION">
31
<summary>
32
Specifies the calling convention used for the binding.
33
</summary>
34
<remarks>
35
Specifies <see cref="F:System.Runtime.InteropServices.CallingConvention.Winapi"/>.
36
</remarks>
37
</member>
38
<member name="F:Tao.PhysFs.Fs.PHYSFS_VER_MAJOR">
39
<summary>
40
Tao.PhysFs's major version.
41
</summary>
42
</member>
43
<member name="F:Tao.PhysFs.Fs.PHYSFS_VER_MINOR">
44
<summary>
45
Tao.PhysFs's minor version.
46
</summary>
47
</member>
48
<member name="F:Tao.PhysFs.Fs.PHYSFS_VER_PATCH">
49
<summary>
50
Tao.PhysFs's patch version.
51
</summary>
52
</member>
53
<member name="M:Tao.PhysFs.Fs.PHYSFS_VERSION(Tao.PhysFs.Fs.PHYSFS_Version@)">
54
<summary>
55
Information the version of PhysicsFS in use.
56
</summary>
57
<remarks>Represents the library's version as three levels: major revision (increments with massive changes, additions, and enhancements), minor revision (increments with backwards-compatible changes to the major revision), and patchlevel (increments with fixes to the minor revision).</remarks>
58
<param name="ver">The <see cref="T:Tao.PhysFs.Fs.PHYSFS_Version"/> to change.</param>
59
<seealso cref="T:Tao.PhysFs.Fs.PHYSFS_Version"/>
60
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getLinkedVersion(Tao.PhysFs.Fs.PHYSFS_Version@)"/>
61
</member>
62
<member name="M:Tao.PhysFs.Fs.PHYSFS_addToSearchPath(System.String,System.Int32)">
63
<summary>
64
Add an archive or directory to the search path.
65
</summary>
66
<remarks>If this is a duplicate, the entry is not added again, even though the function succeeds.</remarks>
67
<param name="newDir">directory or archive to add to the path, in platform-dependent notation.</param>
68
<param name="appendToPath">nonzero to append to search path, zero to prepend.</param>
69
<returns>nonzero if added to path, zero on failure (bogus archive, dir missing, etc). Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
70
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_removeFromSearchPath(System.String)"/>
71
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getSearchPath"/>
72
</member>
73
<member name="M:Tao.PhysFs.Fs.PHYSFS_close(System.IntPtr)">
74
<summary>
75
Close a PhysicsFS filehandle.
76
</summary>
77
<remarks>This call is capable of failing if the operating system was buffering writes to the physical media, and, now forced to write those changes to physical media, can not store the data for some reason. In such a case, the filehandle stays open. A well-written program should ALWAYS check the return value from the close call in addition to every writing call!</remarks>
78
<param name="handle">handle returned from PHYSFS_open*().</param>
79
<returns>nonzero on success, zero on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
80
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>
81
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openWrite(System.String)"/>
82
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openAppend(System.String)"/>
83
</member>
84
<member name="M:Tao.PhysFs.Fs.PHYSFS_deinit">
85
<summary>
86
Deinitialize the PhysicsFS library.
87
</summary>
88
<remarks>This closes any files opened via PhysicsFS, blanks the search/write paths, frees memory, and invalidates all of your file handles.
89
<p>Note that this call can FAIL if there's a file open for writing that refuses to close (for example, the underlying operating system was buffering writes to network filesystem, and the fileserver has crashed, or a hard drive has failed, etc). It is usually best to close all write handles yourself before calling this function, so that you can gracefully handle a specific failure.</p>
90
<p>Once successfully deinitialized, <see cref="M:Tao.PhysFs.Fs.PHYSFS_init(System.String)"/> can be called again to restart the subsystem. All defaults API states are restored at this point.</p></remarks>
91
<returns>nonzero on success, zero on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>. If failure, state of PhysFS is undefined, and probably badly screwed up.</returns>
92
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_init(System.String)"/>
93
</member>
94
<member name="M:Tao.PhysFs.Fs.PHYSFS_delete(System.String)">
95
<summary>
96
Delete a file or directory.
97
</summary>
98
<remarks>(filename) is specified in platform-independent notation in relation to the write dir.
99
<p>A directory must be empty before this call can delete it.</p>
100
<p>Deleting a symlink will remove the link, not what it points to, regardless of whether you "permitSymLinks" or not.</p>
101
<p>So if you've got the write dir set to "C:\mygame\writedir" and call PHYSFS_delete("downloads/maps/level1.map") then the file "C:\mygame\writedir\downloads\maps\level1.map" is removed from the physical filesystem, if it exists and the operating system permits the deletion.</p>
102
<p>Note that on Unix systems, deleting a file may be successful, but the actual file won't be removed until all processes that have an open filehandle to it (including your program) close their handles.</p>
103
<p>Chances are, the bits that make up the file still exist, they are just made available to be written over at a later point. Don't consider this a security method or anything.</p></remarks>
104
<param name="filename">Filename to delete.</param>
105
<returns>nonzero on success, zero on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
106
</member>
107
<member name="M:Tao.PhysFs.Fs.PHYSFS_enumerateFilesInternal(System.String)">
108
<summary>
109
Get a file listing of a search path's directory.
110
</summary>
111
<param name="dir">directory in platform-independent notation to enumerate.</param>
112
<returns>Null-terminated array of null-terminated strings.</returns>
113
<remarks>Matching directories are interpolated. That is, if "C:\mydir" is in the search path and contains a directory "savegames" that contains "x.sav", "y.sav", and "z.sav", and there is also a "C:\userdir" in the search path that has a "savegames" subdirectory with "w.sav", then the following code:
114
<code>
115
char **rc = PHYSFS_enumerateFiles("savegames");
116
char **i;
117
for (i = rc; *i != NULL; i++)
118
printf(" * We've got [%s].\n", *i);
119
PHYSFS_freeList(rc);
120
</code>
121
...will print:
122
<code>
123
* We've got [x.sav].
124
* We've got [y.sav].
125
* We've got [z.sav].
126
* We've got [w.sav].
127
</code>
128
<p>Feel free to sort the list however you like. We only promise there will be no duplicates, but not what order the final list will come back in.</p>
129
<p>Don't forget to call <see cref="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)"/> with the return value from this function when you are done with it.</p>
130
</remarks>
131
</member>
132
<member name="M:Tao.PhysFs.Fs.PHYSFS_enumerateFiles(System.String)">
133
<summary>
134
Get a file listing of a search path's directory.
135
</summary>
136
<param name="dir">directory in platform-independent notation to enumerate.</param>
137
<returns>Null-terminated array of null-terminated strings.</returns>
138
<remarks>Matching directories are interpolated. That is, if "C:\mydir" is in the search path and contains a directory "savegames" that contains "x.sav", "y.sav", and "z.sav", and there is also a "C:\userdir" in the search path that has a "savegames" subdirectory with "w.sav", then the following code:
139
<code>
140
char **rc = PHYSFS_enumerateFiles("savegames");
141
char **i;
142
for (i = rc; *i != NULL; i++)
143
printf(" * We've got [%s].\n", *i);
144
PHYSFS_freeList(rc);
145
</code>
146
...will print:
147
<code>
148
* We've got [x.sav].
149
* We've got [y.sav].
150
* We've got [z.sav].
151
* We've got [w.sav].
152
</code>
153
<p>Feel free to sort the list however you like. We only promise there will be no duplicates, but not what order the final list will come back in.</p>
154
<p>Don't forget to call <see cref="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)"/> with the return value from this function when you are done with it.</p>
155
<p>Note that Tao.PhysFs calls <see cref="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)"/> for you.</p>
156
</remarks>
157
</member>
158
<member name="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)">
159
<summary>
160
Check for end-of-file state on a PhysicsFS filehandle.
161
</summary>
162
<remarks>Determine if the end of file has been reached in a PhysicsFS filehandle.</remarks>
163
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
164
<returns>nonzero if EOF, zero if not.</returns>
165
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>
166
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_tell(System.IntPtr)"/>
167
</member>
168
<member name="M:Tao.PhysFs.Fs.PHYSFS_exists(System.String)">
169
<summary>
170
Determine if a file exists in the search path.
171
</summary>
172
<remarks>Reports true if there is an entry anywhere in the search path by the name of (fname).
173
<p>Note that entries that are symlinks are ignored if PHYSFS_permitSymbolicLinks(1) hasn't been called, so you might end up further down in the search path than expected.</p></remarks>
174
<param name="fname">filename in platform-independent notation.</param>
175
<returns>non-zero if filename exists. zero otherwise.</returns>
176
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_isDirectory(System.String)"/>
177
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_isSymbolicLink(System.String)"/>
178
</member>
179
<member name="M:Tao.PhysFs.Fs.PHYSFS_fileLength(System.IntPtr)">
180
<summary>
181
Get total length of a file in bytes.
182
</summary>
183
<remarks>Note that if the file size can't be determined (since the archive is "streamed" or whatnot) than this will report (-1). Also note that if another process/thread is writing to this file at the same time, then the information this function supplies could be incorrect before you get it. Use with caution, or better yet, don't use at all.</remarks>
184
<param name="handle">handle returned from PHYSFS_open*().</param>
185
<returns>size in bytes of the file. -1 if can't be determined.</returns>
186
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_tell(System.IntPtr)"/>
187
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_seek(System.IntPtr,System.UInt64)"/>
188
</member>
189
<member name="M:Tao.PhysFs.Fs.PHYSFS_flush(System.IntPtr)">
190
<summary>
191
Flush a buffered PhysicsFS file handle.
192
</summary>
193
<remarks>For buffered files opened for writing, this will put the current contents of the buffer to disk and flag the buffer as empty if possible.
194
<p>For buffered files opened for reading or unbuffered files, this is a safe no-op, and will report success.</p></remarks>
195
<param name="handle">handle returned from PHYSFS_open*().</param>
196
<returns>nonzero if successful, zero on error.</returns>
197
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_setBuffer(System.IntPtr,System.UInt64)"/>
198
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_close(System.IntPtr)"/>
199
</member>
200
<member name="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)">
201
<summary>
202
Deallocate resources of lists returned by PhysicsFS.
203
</summary>
204
<remarks>Certain PhysicsFS functions return lists of information that are dynamically allocated. Use this function to free those resources.</remarks>
205
<param name="listVar">List of information specified as freeable by this function.</param>
206
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getCdRomDirs"/>
207
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_enumerateFiles(System.String)"/>
208
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getSearchPath"/>
209
</member>
210
<member name="M:Tao.PhysFs.Fs.PHYSFS_getBaseDir">
211
<summary>
212
Get the path where the application resides.
213
</summary>
214
<remarks>Helper function.
215
<p>Get the "base dir". This is the directory where the application was run from, which is probably the installation directory, and may or may not be the process's current working directory.</p>
216
<p>You should probably use the base dir in your search path.</p></remarks>
217
<returns>string of base dir in platform-dependent notation.</returns>
218
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getUserDir"/>
219
</member>
220
<member name="M:Tao.PhysFs.Fs.PHYSFS_getCdRomDirsInternal">
221
<summary>
222
Get an array of paths to available CD-ROM drives.
223
</summary>
224
<remarks>The dirs returned are platform-dependent ("D:\" on Win32, "/cdrom" or whatnot on Unix). Dirs are only returned if there is a disc ready and accessible in the drive. So if you've got two drives (D: and E:), and only E: has a disc in it, then that's all you get. If the user inserts a disc in D: and you call this function again, you get both drives. If, on a Unix box, the user unmounts a disc and remounts it elsewhere, the next call to this function will reflect that change. Fun.
225
<p>The returned value is an array of strings, with a NULL entry to signify the end of the list:</p>
226
<p><code>
227
char **cds = PHYSFS_getCdRomDirs();
228
char **i;
229
for (i = cds; *i != NULL; i++)
230
printf("cdrom dir [%s] is available.\n", *i);
231
PHYSFS_freeList(cds);</code></p>
232
<p>This call may block while drives spin up. Be forewarned.</p>
233
<p>When you are done with the returned information, you may dispose of the resources by calling <see cref="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)"/> with the returned pointer.</p></remarks>
234
<returns>Null-terminated array of null-terminated strings.</returns>
235
</member>
236
<member name="M:Tao.PhysFs.Fs.PHYSFS_getCdRomDirs">
237
<summary>
238
Get an array of paths to available CD-ROM drives.
239
</summary>
240
<remarks>The dirs returned are platform-dependent ("D:\" on Win32, "/cdrom" or whatnot on Unix). Dirs are only returned if there is a disc ready and accessible in the drive. So if you've got two drives (D: and E:), and only E: has a disc in it, then that's all you get. If the user inserts a disc in D: and you call this function again, you get both drives. If, on a Unix box, the user unmounts a disc and remounts it elsewhere, the next call to this function will reflect that change. Fun.
241
<p>The returned value is an array of strings, with a NULL entry to signify the end of the list:</p>
242
<p><code>
243
char **cds = PHYSFS_getCdRomDirs();
244
char **i;
245
for (i = cds; *i != NULL; i++)
246
printf("cdrom dir [%s] is available.\n", *i);
247
PHYSFS_freeList(cds);</code></p>
248
<p>This call may block while drives spin up. Be forewarned.</p>
249
<p>When you are done with the returned information, you may dispose of the resources by calling <see cref="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)"/> with the returned pointer.</p>
250
<p>Note that Tao.PhysFs calls <see cref="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)"/> for you.</p>
251
</remarks>
252
<returns>Null-terminated array of null-terminated strings.</returns>
253
</member>
254
<member name="M:Tao.PhysFs.Fs.PHYSFS_getDirSeparator">
255
<summary>
256
Get platform-dependent dir separator string.
257
</summary>
258
<remarks>This returns "\\\\" on win32, "/" on Unix, and ":" on MacOS. It may be more than one character, depending on the platform, and your code should take that into account. Note that this is only useful for setting up the search/write paths, since access into those dirs always use '/' (platform-independent notation) to separate directories. This is also handy for getting platform-independent access when using stdio calls.</remarks>
259
<returns>null-terminated string of platform's dir separator.</returns>
260
</member>
261
<member name="M:Tao.PhysFs.Fs.PHYSFS_getLastError">
262
<summary>
263
Get human-readable error information.
264
</summary>
265
<remarks>Get the last PhysicsFS error message as a null-terminated string. This will be NULL if there's been no error since the last call to this function. The pointer returned by this call points to an internal buffer. Each thread has a unique error state associated with it, but each time a new error message is set, it will overwrite the previous one associated with that thread. It is safe to call this function at anytime, even before <see cref="M:Tao.PhysFs.Fs.PHYSFS_init(System.String)"/>.</remarks>
266
<returns>string of last error message.</returns>
267
</member>
268
<member name="M:Tao.PhysFs.Fs.PHYSFS_getLastModTime(System.String)">
269
<summary>
270
Get the last modification time of a file.
271
</summary>
272
<remarks>The modtime is returned as a number of seconds since the epoch (Jan 1, 1970). The exact derivation and accuracy of this time depends on the particular archiver. If there is no reasonable way to obtain this information for a particular archiver, or there was some sort of error, this function returns (-1).</remarks>
273
<param name="filename">filename to check, in platform-independent notation.</param>
274
<returns>last modified time of the file. -1 if it can't be determined.</returns>
275
</member>
276
<member name="M:Tao.PhysFs.Fs.PHYSFS_getLinkedVersion(Tao.PhysFs.Fs.PHYSFS_Version@)">
277
<summary>
278
Get the version of PhysicsFS that is linked against your program.
279
</summary>
280
<remarks>This function may be called safely at any time, even before <see cref="M:Tao.PhysFs.Fs.PHYSFS_init(System.String)"/>.</remarks>
281
<param name="ver">The output PHYSFS_Version structure.</param>
282
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_VERSION(Tao.PhysFs.Fs.PHYSFS_Version@)"/>
283
</member>
284
<member name="M:Tao.PhysFs.Fs.PHYSFS_getRealDir(System.String)">
285
<summary>
286
Figure out where in the search path a file resides.
287
</summary>
288
<remarks>The file is specified in platform-independent notation. The returned filename will be the element of the search path where the file was found, which may be a directory, or an archive. Even if there are multiple matches in different parts of the search path, only the first one found is used, just like when opening a file.
289
<p>So, if you look for "maps/level1.map", and C:\mygame is in your search path and C:\mygame\maps\level1.map exists, then "C:\mygame" is returned.</p>
290
<p>If a any part of a match is a symbolic link, and you've not explicitly permitted symlinks, then it will be ignored, and the search for a match will continue.</p></remarks>
291
<param name="filename">file to look for.</param>
292
<returns>string of element of search path containing the the file in question. NULL if not found.</returns>
293
</member>
294
<member name="M:Tao.PhysFs.Fs.PHYSFS_getSearchPath">
295
<summary>
296
Get the current search path.
297
</summary>
298
<remarks>The default search path is an empty list.
299
<p>The returned value is an array of strings, with a NULL entry to signify the end of the list:</p>
300
<p>
301
<code>
302
char **i;
303
for (i = PHYSFS_getSearchPath(); *i != NULL; i++)
304
printf("[%s] is in the search path.\n", *i);
305
</code></p>
306
<p>When you are done with the returned information, you may dispose of the resources by calling <see cref="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)"/> with the returned pointer.</p>
307
<p>Please note that Tao.PhysFs calls <see cref="M:Tao.PhysFs.Fs.PHYSFS_freeList(System.IntPtr)"/> for you.</p>
308
</remarks>
309
<returns>Null-terminated array of null-terminated strings. NULL if there was a problem (read: OUT OF MEMORY).</returns>
310
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_addToSearchPath(System.String,System.Int32)"/>
311
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_removeFromSearchPath(System.String)"/>
312
</member>
313
<member name="M:Tao.PhysFs.Fs.PHYSFS_getSearchPathInternal">
314
<summary>
315
Get the current search path.
316
</summary>
317
<remarks>The default search path is an empty list.
318
<p>The returned value is an array of strings, with a NULL entry to signify the end of the list:</p>
319
<p>
320
<code>
321
char **i;
322
for (i = PHYSFS_getSearchPath(); *i != NULL; i++)
323
printf("[%s] is in the search path.\n", *i);
324
</code></p>
325
<p>When you are done with the returned information, you may dispose of the resources by calling PHYSFS_freeList() with the returned pointer.</p></remarks>
326
<returns>Null-terminated array of null-terminated strings. NULL if there was a problem (read: OUT OF MEMORY).</returns>
327
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_addToSearchPath(System.String,System.Int32)"/>
328
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_removeFromSearchPath(System.String)"/>
329
</member>
330
<member name="M:Tao.PhysFs.Fs.PHYSFS_getUserDir">
331
<summary>
332
Get the path where user's home directory resides.
333
</summary>
334
<remarks>Helper function.
335
<p>Get the "user dir". This is meant to be a suggestion of where a specific user of the system can store files. On Unix, this is her home directory. On systems with no concept of multiple home directories (MacOS, win95), this will default to something like "C:\mybasedir\users\username" where "username" will either be the login name, or "default" if the platform doesn't support multiple users, either.</p>
336
<p>You should probably use the user dir as the basis for your write dir, and also put it near the beginning of your search path.</p></remarks>
337
<returns>string of user dir in platform-dependent notation.</returns>
338
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getBaseDir"/>
339
</member>
340
<member name="M:Tao.PhysFs.Fs.PHYSFS_getWriteDir">
341
<summary>
342
Get path where PhysicsFS will allow file writing.
343
</summary>
344
<remarks>Get the current write dir. The default write dir is NULL.</remarks>
345
<returns>string of write dir in platform-dependent notation, OR NULL IF NO WRITE PATH IS CURRENTLY SET.</returns>
346
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_setWriteDir(System.String)"/>
347
</member>
348
<member name="M:Tao.PhysFs.Fs.PHYSFS_init(System.String)">
349
<summary>
350
Initialize the PhysicsFS library.
351
</summary>
352
<remarks>This must be called before any other PhysicsFS function.
353
<p>This should be called prior to any attempts to change your process's current working directory.</p></remarks>
354
<param name="argv0">the argv[0] string passed to your program's mainline. This may be NULL on most platforms (such as ones without a standard main() function), but you should always try to pass something in here. Unix-like systems such as Linux _need_ to pass argv[0] from main() in here.</param>
355
<returns>nonzero on success, zero on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
356
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_deinit"/>
357
</member>
358
<member name="M:Tao.PhysFs.Fs.PHYSFS_isDirectory(System.String)">
359
<summary>
360
Determine if a file in the search path is really a directory.
361
</summary>
362
<remarks>Determine if the first occurence of (fname) in the search path is really a directory entry.
363
<p>Note that entries that are symlinks are ignored if PHYSFS_permitSymbolicLinks(1) hasn't been called, so you might end up further down in the search path than expected.</p></remarks>
364
<param name="filename">filename in platform-independent notation.</param>
365
<returns>non-zero if filename exists and is a directory. zero otherwise.</returns>
366
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_exists(System.String)"/>
367
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_isSymbolicLink(System.String)"/>
368
</member>
369
<member name="M:Tao.PhysFs.Fs.PHYSFS_isSymbolicLink(System.String)">
370
<summary>
371
Determine if a file in the search path is really a symbolic link.
372
</summary>
373
<remarks>Determine if the first occurence of (fname) in the search path is really a symbolic link.
374
<p>Note that entries that are symlinks are ignored if PHYSFS_permitSymbolicLinks(1) hasn't been called, and as such, this function will always return 0 in that case.</p></remarks>
375
<param name="filename">filename in platform-independent notation.</param>
376
<returns>non-zero if filename exists and is a symlink. zero otherwise.</returns>
377
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_exists(System.String)"/>
378
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_isDirectory(System.String)"/>
379
</member>
380
<member name="M:Tao.PhysFs.Fs.PHYSFS_mkdir(System.String)">
381
<summary>
382
Create a directory.
383
</summary>
384
<remarks>This is specified in platform-independent notation in relation to the write dir. All missing parent directories are also created if they don't exist.
385
<p>So if you've got the write dir set to "C:\mygame\writedir" and call PHYSFS_mkdir("downloads/maps") then the directories "C:\mygame\writedir\downloads" and "C:\mygame\writedir\downloads\maps" will be created if possible. If the creation of "maps" fails after we have successfully created "downloads", then the function leaves the created directory behind and reports failure.</p></remarks>
386
<param name="dirName">New dir to create.</param>
387
<returns>nonzero on success, zero on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
388
</member>
389
<member name="M:Tao.PhysFs.Fs.PHYSFS_openAppend(System.String)">
390
<summary>
391
Open a file for appending.
392
</summary>
393
<remarks>Open a file for writing, in platform-independent notation and in relation to the write dir as the root of the writable filesystem. The specified file is created if it doesn't exist. If it does exist, the writing offset is set to the end of the file, so the first write will be the byte after the end.
394
<p>Note that entries that are symlinks are ignored if PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a symlink with this function will fail in such a case.</p></remarks>
395
<param name="filename">File to open.</param>
396
<returns>A valid PhysicsFS filehandle on success, NULL on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
397
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>
398
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openWrite(System.String)"/>
399
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_write(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>
400
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_close(System.IntPtr)"/>
401
</member>
402
<member name="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)">
403
<summary>
404
Open a file for reading.
405
</summary>
406
<remarks>Open a file for reading, in platform-independent notation. The search path is checked one at a time until a matching file is found, in which case an abstract filehandle is associated with it, and reading may be done. The reading offset is set to the first byte of the file.
407
<p>Note that entries that are symlinks are ignored if PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a symlink with this function will fail in such a case.</p></remarks>
408
<param name="filename">File to open.</param>
409
<returns>A valid PhysicsFS filehandle on success, NULL on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
410
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openWrite(System.String)"/>
411
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openAppend(System.String)"/>
412
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>
413
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_close(System.IntPtr)"/>
414
</member>
415
<member name="M:Tao.PhysFs.Fs.PHYSFS_openWrite(System.String)">
416
<summary>
417
Open a file for writing.
418
</summary>
419
<remarks>Open a file for writing, in platform-independent notation and in relation to the write dir as the root of the writable filesystem. The specified file is created if it doesn't exist. If it does exist, it is truncated to zero bytes, and the writing offset is set to the start.
420
<p>Note that entries that are symlinks are ignored if PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a symlink with this function will fail in such a case.</p></remarks>
421
<param name="filename">File to open.</param>
422
<returns>A valid PhysicsFS filehandle on success, NULL on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
423
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>
424
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openAppend(System.String)"/>
425
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_write(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>
426
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_close(System.IntPtr)"/>
427
</member>
428
<member name="M:Tao.PhysFs.Fs.PHYSFS_permitSymbolicLinks(System.Int32)">
429
<summary>
430
Enable or disable following of symbolic links.
431
</summary>
432
<remarks>Some physical filesystems and archives contain files that are just pointers to other files. On the physical filesystem, opening such a link will (transparently) open the file that is pointed to.
433
<p>By default, PhysicsFS will check if a file is really a symlink during open calls and fail if it is. Otherwise, the link could take you outside the write and search paths, and compromise security.</p>
434
<p>If you want to take that risk, call this function with a non-zero parameter. Note that this is more for sandboxing a program's scripting language, in case untrusted scripts try to compromise the system. Generally speaking, a user could very well have a legitimate reason to set up a symlink, so unless you feel there's a specific danger in allowing them, you should permit them.</p>
435
<p>Symlinks are only explicitly checked when dealing with filenames in platform-independent notation. That is, when setting up your search and write paths, etc, symlinks are never checked for.</p>
436
<p>Symbolic link permission can be enabled or disabled at any time after you've called PHYSFS_init(), and is disabled by default.</p></remarks>
437
<param name="allow">nonzero to permit symlinks, zero to deny linking.</param>
438
</member>
439
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)">
440
<summary>
441
Read data from a PhysicsFS filehandle to a buffer location which already has memory allocated to it.
442
</summary>
443
<remarks>The file must be opened for reading. Memory must be allocated.</remarks>
444
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
445
<param name="buffer">buffer to store read data into.</param>
446
<param name="objSize">size in bytes of objects being read from (handle).</param>
447
<param name="objCount">number of (objSize) objects to read from (handle).</param>
448
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
449
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
450
</member>
451
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.IntPtr@,System.UInt32,System.UInt32)">
452
<summary>
453
Read data from a PhysicsFS filehandle. Buffer memory is allocated for you.
454
</summary>
455
<remarks>The file must be opened for reading. Note that this allocates memory and points to it through the buffer. You must then free the memory by using Marshal.FreeHGlobal(buffer)</remarks>
456
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
457
<param name="buffer">buffer where memory is stored. Memory is allocated for you.</param>
458
<param name="objSize">size in bytes of objects being read from (handle).</param>
459
<param name="objCount">number of (objSize) objects to read from (handle).</param>
460
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
461
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
462
</member>
463
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.Byte[]@,System.UInt32,System.UInt32)">
464
<summary>
465
Read a byte array from a PhysicsFS filehandle.
466
</summary>
467
<remarks>The file must be opened for reading.</remarks>
468
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
469
<param name="buffer">byte array to read in</param>
470
<param name="objSize">size in bytes of objects being read from (handle).</param>
471
<param name="objCount">number of (objSize) objects to read from (handle).</param>
472
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
473
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
474
</member>
475
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.Char[]@,System.UInt32,System.UInt32)">
476
<summary>
477
Read a char array from a PhysicsFS filehandle.
478
</summary>
479
<remarks>The file must be opened for reading.</remarks>
480
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
481
<param name="buffer">char array to read in</param>
482
<param name="objSize">size in bytes of objects being read from (handle).</param>
483
<param name="objCount">number of (objSize) objects to read from (handle).</param>
484
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
485
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
486
</member>
487
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.Double[]@,System.UInt32,System.UInt32)">
488
<summary>
489
Read a double array from a PhysicsFS filehandle.
490
</summary>
491
<remarks>The file must be opened for reading.</remarks>
492
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
493
<param name="buffer">double array to read in</param>
494
<param name="objSize">size in bytes of objects being read from (handle).</param>
495
<param name="objCount">number of (objSize) objects to read from (handle).</param>
496
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
497
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
498
</member>
499
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.Single[]@,System.UInt32,System.UInt32)">
500
<summary>
501
Read a float array from a PhysicsFS filehandle.
502
</summary>
503
<remarks>The file must be opened for reading.</remarks>
504
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
505
<param name="buffer">float array to read in</param>
506
<param name="objSize">size in bytes of objects being read from (handle).</param>
507
<param name="objCount">number of (objSize) objects to read from (handle).</param>
508
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
509
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
510
</member>
511
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.Int32[]@,System.UInt32,System.UInt32)">
512
<summary>
513
Read a integer array from a PhysicsFS filehandle.
514
</summary>
515
<remarks>The file must be opened for reading.</remarks>
516
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
517
<param name="buffer">integer array to read in</param>
518
<param name="objSize">size in bytes of objects being read from (handle).</param>
519
<param name="objCount">number of (objSize) objects to read from (handle).</param>
520
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
521
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
522
</member>
523
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.Int64[]@,System.UInt32,System.UInt32)">
524
<summary>
525
Read a array of long values from a PhysicsFS filehandle.
526
</summary>
527
<remarks>The file must be opened for reading.</remarks>
528
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
529
<param name="buffer">byte array to read in</param>
530
<param name="objSize">size in bytes of objects being read from (handle).</param>
531
<param name="objCount">number of (objSize) objects to read from (handle).</param>
532
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
533
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
534
</member>
535
<member name="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.Int16[]@,System.UInt32,System.UInt32)">
536
<summary>
537
Read a array of short values from a PhysicsFS filehandle.
538
</summary>
539
<remarks>The file must be opened for reading.</remarks>
540
<param name="handle">handle returned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>.</param>
541
<param name="buffer">short array to read in</param>
542
<param name="objSize">size in bytes of objects being read from (handle).</param>
543
<param name="objCount">number of (objSize) objects to read from (handle).</param>
544
<returns>number of objects read. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/> can shed light on the reason this might be less than (objCount), as can <see cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>. -1 if complete failure.</returns>
545
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
546
</member>
547
<member name="M:Tao.PhysFs.Fs.PHYSFS_readSBE16(System.IntPtr,System.Int16@)">
548
<summary>
549
Read and convert a signed 16-bit bigendian value.
550
</summary>
551
<remarks>Convenience function. Read a signed 16-bit bigendian value from a file and convert it to the platform's native byte order.</remarks>
552
<param name="handle">PhysicsFS file handle from which to read.</param>
553
<param name="val">Where value should be stored.</param>
554
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
555
</member>
556
<member name="M:Tao.PhysFs.Fs.PHYSFS_readSBE32(System.IntPtr,System.Int32@)">
557
<summary>
558
Read and convert a signed 32-bit bigendian value.
559
</summary>
560
<remarks>Convenience function. Read a signed 32-bit bigendian value from a file and convert it to the platform's native byte order.</remarks>
561
<param name="handle">PhysicsFS file handle from which to read.</param>
562
<param name="val">Where value should be stored.</param>
563
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
564
</member>
565
<member name="M:Tao.PhysFs.Fs.PHYSFS_readSBE64(System.IntPtr,System.Int64@)">
566
<summary>
567
Read and convert a signed 64-bit bigendian value.
568
</summary>
569
<remarks>Convenience function. Read a signed 64-bit bigendian value from a file and convert it to the platform's native byte order.</remarks>
570
<param name="handle">PhysicsFS file handle from which to read.</param>
571
<param name="val">Where value should be stored.</param>
572
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
573
</member>
574
<member name="M:Tao.PhysFs.Fs.PHYSFS_readSLE16(System.IntPtr,System.Int16@)">
575
<summary>
576
Read and convert a signed 16-bit littleendian value.
577
</summary>
578
<remarks>Convenience function. Read a signed 16-bit littleendian value from a file and convert it to the platform's native byte order.</remarks>
579
<param name="handle">PhysicsFS file handle from which to read.</param>
580
<param name="val">Where value should be stored.</param>
581
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
582
</member>
583
<member name="M:Tao.PhysFs.Fs.PHYSFS_readSLE32(System.IntPtr,System.Int32@)">
584
<summary>
585
Read and convert a signed 32-bit littleendian value.
586
</summary>
587
<remarks>Convenience function. Read a signed 32-bit littleendian value from a file and convert it to the platform's native byte order.</remarks>
588
<param name="handle">PhysicsFS file handle from which to read.</param>
589
<param name="val">Where value should be stored.</param>
590
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
591
</member>
592
<member name="M:Tao.PhysFs.Fs.PHYSFS_readSLE64(System.IntPtr,System.Int64@)">
593
<summary>
594
Read and convert a signed 64-bit littleendian value.
595
</summary>
596
<remarks>Convenience function. Read a signed 64-bit littleendian value from a file and convert it to the platform's native byte order.</remarks>
597
<param name="handle">PhysicsFS file handle from which to read.</param>
598
<param name="val">Where value should be stored.</param>
599
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
600
</member>
601
<member name="M:Tao.PhysFs.Fs.PHYSFS_readUBE16(System.IntPtr,System.UInt16@)">
602
<summary>
603
Read and convert an unsigned 16-bit bigendian value.
604
</summary>
605
<remarks>Convenience function. Read an unsigned 16-bit bigendian value from a file and convert it to the platform's native byte order.</remarks>
606
<param name="handle">PhysicsFS file handle from which to read.</param>
607
<param name="val">Where value should be stored.</param>
608
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
609
</member>
610
<member name="M:Tao.PhysFs.Fs.PHYSFS_readUBE32(System.IntPtr,System.UInt32@)">
611
<summary>
612
Read and convert an unsigned 32-bit bigendian value.
613
</summary>
614
<remarks>Convenience function. Read an unsigned 32-bit bigendian value from a file and convert it to the platform's native byte order.</remarks>
615
<param name="handle">PhysicsFS file handle from which to read.</param>
616
<param name="val">Where value should be stored.</param>
617
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
618
</member>
619
<member name="M:Tao.PhysFs.Fs.PHYSFS_readUBE64(System.IntPtr,System.UInt64@)">
620
<summary>
621
Read and convert an unsigned 64-bit bigendian value.
622
</summary>
623
<remarks>Convenience function. Read an unsigned 64-bit bigendian value from a file and convert it to the platform's native byte order.</remarks>
624
<param name="handle">PhysicsFS file handle from which to read.</param>
625
<param name="val">Where value should be stored.</param>
626
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
627
</member>
628
<member name="M:Tao.PhysFs.Fs.PHYSFS_readULE16(System.IntPtr,System.UInt16@)">
629
<summary>
630
Read and convert an unsigned 16-bit littleendian value.
631
</summary>
632
<remarks>Convenience function. Read an unsigned 16-bit littleendian value from a file and convert it to the platform's native byte order.</remarks>
633
<param name="handle">PhysicsFS file handle from which to read.</param>
634
<param name="val">Where value should be stored.</param>
635
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
636
</member>
637
<member name="M:Tao.PhysFs.Fs.PHYSFS_readULE32(System.IntPtr,System.UInt32@)">
638
<summary>
639
Read and convert an unsigned 32-bit littleendian value.
640
</summary>
641
<remarks>Convenience function. Read an unsigned 32-bit littleendian value from a file and convert it to the platform's native byte order.</remarks>
642
<param name="handle">PhysicsFS file handle from which to read.</param>
643
<param name="val">Where value should be stored.</param>
644
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
645
</member>
646
<member name="M:Tao.PhysFs.Fs.PHYSFS_readULE64(System.IntPtr,System.UInt32@)">
647
<summary>
648
Read and convert an unsigned 64-bit littleendian value.
649
</summary>
650
<remarks>Convenience function. Read an unsigned 64-bit littleendian value from a file and convert it to the platform's native byte order.</remarks>
651
<param name="handle">PhysicsFS file handle from which to read.</param>
652
<param name="val">Where value should be stored.</param>
653
<returns>zero on failure, non-zero on success. If successful, val will store the result. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
654
</member>
655
<member name="M:Tao.PhysFs.Fs.PHYSFS_removeFromSearchPath(System.String)">
656
<summary>
657
Remove a directory or archive from the search path.
658
</summary>
659
<remarks>This must be a (case-sensitive) match to a dir or archive already in the search path, specified in platform-dependent notation.
660
<p>This call will fail (and fail to remove from the path) if the element still has files open in it.</p></remarks>
661
<param name="oldDir">dir/archive to remove.</param>
662
<returns>nonzero on success, zero on failure. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
663
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_addToSearchPath(System.String,System.Int32)"/>
664
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getSearchPath"/>
665
</member>
666
<member name="M:Tao.PhysFs.Fs.PHYSFS_seek(System.IntPtr,System.UInt64)">
667
<summary>
668
Seek to a new position within a PhysicsFS filehandle.
669
</summary>
670
<remarks>The next read or write will occur at that place. Seeking past the beginning or end of the file is not allowed, and causes an error.</remarks>
671
<param name="handle">handle returned from PHYSFS_open*().</param>
672
<param name="pos">number of bytes from start of file to seek to.</param>
673
<returns>nonzero on success, zero on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
674
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_tell(System.IntPtr)"/>
675
</member>
676
<member name="M:Tao.PhysFs.Fs.PHYSFS_setBuffer(System.IntPtr,System.UInt64)">
677
<summary>
678
Set up buffering for a PhysicsFS file handle.
679
</summary>
680
<remarks>Define an i/o buffer for a file handle. A memory block of (bufsize) bytes will be allocated and associated with (handle).
681
<p>For files opened for reading, up to (bufsize) bytes are read from (handle) and stored in the internal buffer. Calls to <see cref="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>() will pull from this buffer until it is empty, and then refill it for more reading. Note that compressed files, like ZIP archives, will decompress while buffering, so this can be handy for offsetting CPU-intensive operations. The buffer isn't filled until you do your next read.</p>
682
<p>For files opened for writing, data will be buffered to memory until the buffer is full or the buffer is flushed. Closing a handle implicitly causes a flush...check your return values!</p>
683
<p>Seeking, etc transparently accounts for buffering.</p>
684
<p>You can resize an existing buffer by calling this function more than once on the same file. Setting the buffer size to zero will free an existing buffer.</p>
685
<p>PhysicsFS file handles are unbuffered by default.</p>
686
<p>Please check the return value of this function! Failures can include not being able to seek backwards in a read-only file when removing the buffer, not being able to allocate the buffer, and not being able to flush the buffer to disk, among other unexpected problems.</p></remarks>
687
<param name="handle">handle returned from PHYSFS_open*().</param>
688
<param name="bufsize">size, in bytes, of buffer to allocate.</param>
689
<returns>nonzero if successful, zero on error.</returns>
690
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_flush(System.IntPtr)"/>
691
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>
692
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_write(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>
693
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_close(System.IntPtr)"/>
694
</member>
695
<member name="M:Tao.PhysFs.Fs.PHYSFS_setSaneConfig(System.String,System.String,System.String,System.Int32,System.Int32)">
696
<summary>
697
Set up sane, default paths.
698
</summary>
699
<remarks>Helper function.
700
<p>The write dir will be set to "userdir/.organization/appName", which is created if it doesn't exist.</p>
701
<p>The above is sufficient to make sure your program's configuration directory is separated from other clutter, and platform-independent. The period before "mygame" even hides the directory on Unix systems.</p>
702
<p>The search path will be:
703
* The Write Dir (created if it doesn't exist)
704
* The Base Dir (PHYSFS_getBaseDir())
705
* All found CD-ROM dirs (optionally)</p>
706
<p>These directories are then searched for files ending with the extension (archiveExt), which, if they are valid and supported archives, will also be added to the search path. If you specified "PKG" for (archiveExt), and there's a file named data.PKG in the base dir, it'll be checked. Archives can either be appended or prepended to the search path in alphabetical order, regardless of which directories they were found in.</p>
707
<p>All of this can be accomplished from the application, but this just does it all for you. Feel free to add more to the search path manually, too.</p></remarks>
708
<param name="organization">Name of your company/group/etc to be used as a dirname, so keep it small, and no-frills.</param>
709
<param name="appName">Program-specific name of your program, to separate it from other programs using PhysicsFS.</param>
710
<param name="archiveExt">File extension used by your program to specify an archive. For example, Quake 3 uses "pk3", even though they are just zipfiles. Specify NULL to not dig out archives automatically. Do not specify the '.' char; If you want to look for ZIP files, specify "ZIP" and not ".ZIP" ... the archive search is case-insensitive.</param>
711
<param name="includeCdRoms">Non-zero to include CD-ROMs in the search path, and (if (archiveExt) != NULL) search them for archives. This may cause a significant amount of blocking while discs are accessed, and if there are no discs in the drive (or even not mounted on Unix systems), then they may not be made available anyhow. You may want to specify zero and handle the disc setup yourself.</param>
712
<param name="archivesFirst">Non-zero to prepend the archives to the search path. Zero to append them. Ignored if !(archiveExt).</param>
713
<returns>nonzero on success, zero on error. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
714
</member>
715
<member name="M:Tao.PhysFs.Fs.PHYSFS_setWriteDir(System.String)">
716
<summary>
717
Tell PhysicsFS where it may write files.
718
</summary>
719
<remarks>Set a new write dir. This will override the previous setting. If the directory or a parent directory doesn't exist in the physical filesystem, PhysicsFS will attempt to create them as needed.
720
<p>This call will fail (and fail to change the write dir) if the current write dir still has files open in it.</p></remarks>
721
<param name="newDir">The new directory to be the root of the write dir, specified in platform-dependent notation. Setting to NULL disables the write dir, so no files can be opened for writing via PhysicsFS.</param>
722
<returns>non-zero on success, zero on failure. All attempts to open a file for writing via PhysicsFS will fail until this call succeeds. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
723
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getWriteDir"/>
724
</member>
725
<member name="M:Tao.PhysFs.Fs.PHYSFS_supportedArchiveTypes">
726
<summary>
727
Get a list of supported archive types.
728
</summary>
729
<remarks>Get a list of archive types supported by this implementation of PhysicFS. These are the file formats usable for search path entries. This is for informational purposes only. Note that the extension listed is merely convention: if we list "ZIP", you can open a PkZip-compatible archive with an extension of "XYZ", if you like.
730
<p>The returned value is an array of pointers to PHYSFS_ArchiveInfo structures, with a NULL entry to signify the end of the list:</p>
731
<p>
732
<code>
733
PHYSFS_ArchiveInfo **i;
734
for (i = PHYSFS_supportedArchiveTypes(); *i != NULL; i++)
735
{
736
printf("Supported archive: [%s], which is [%s].\n",
737
i->extension, i->description);
738
}
739
</code>
740
</p>
741
<p>The return values are pointers to static internal memory, and should be considered READ ONLY, and never freed.</p></remarks>
742
<returns>Null-terminated array of READ ONLY structures.</returns>
743
</member>
744
<member name="M:Tao.PhysFs.Fs.PHYSFS_supportedArchiveTypesInternal">
745
<summary>
746
Private bindings to get a list of supported archive types.
747
</summary>
748
<remarks>Get a list of archive types supported by this implementation of PhysicFS. These are the file formats usable for search path entries. This is for informational purposes only. Note that the extension listed is merely convention: if we list "ZIP", you can open a PkZip-compatible archive with an extension of "XYZ", if you like.
749
<p>The returned value is an array of pointers to PHYSFS_ArchiveInfo structures, with a NULL entry to signify the end of the list:</p>
750
<p>
751
<code>
752
PHYSFS_ArchiveInfo **i;
753
for (i = PHYSFS_supportedArchiveTypes(); *i != NULL; i++)
754
{
755
printf("Supported archive: [%s], which is [%s].\n",
756
i->extension, i->description);
757
}
758
</code>
759
</p>
760
<p>The return values are pointers to static internal memory, and should be considered READ ONLY, and never freed.</p></remarks>
761
<returns>READ ONLY Null-terminated array of READ ONLY structures.</returns>
762
</member>
763
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapSBE16(System.Int16)">
764
<summary>
765
Swap bigendian signed 16 to platform's native byte order.
766
</summary>
767
<remarks>Take a 16-bit signed value in bigendian format and convert it to the platform's native byte order.</remarks>
768
<param name="val">value to convert</param>
769
<returns>converted value.</returns>
770
</member>
771
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapSBE32(System.Int32)">
772
<summary>
773
Swap bigendian signed 32 to platform's native byte order.
774
</summary>
775
<remarks>Take a 32-bit signed value in bigendian format and convert it to the platform's native byte order.</remarks>
776
<param name="val">value to convert</param>
777
<returns>converted value.</returns>
778
</member>
779
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapSBE64(System.Int64)">
780
<summary>
781
Swap bigendian signed 64 to platform's native byte order.
782
</summary>
783
<remarks>Take a 64-bit signed value in bigendian format and convert it to the platform's native byte order.</remarks>
784
<param name="val">value to convert</param>
785
<returns>converted value.</returns>
786
</member>
787
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapSLE16(System.Int16)">
788
<summary>
789
Swap littleendian signed 16 to platform's native byte order.
790
</summary>
791
<remarks>Take a 16-bit signed value in littleendian format and convert it to the platform's native byte order.</remarks>
792
<param name="val">value to convert</param>
793
<returns>converted value.</returns>
794
</member>
795
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapSLE32(System.Int32)">
796
<summary>
797
Swap littleendian signed 32 to platform's native byte order.
798
</summary>
799
<remarks>Take a 32-bit signed value in littleendian format and convert it to the platform's native byte order.</remarks>
800
<param name="val">value to convert</param>
801
<returns>converted value.</returns>
802
</member>
803
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapSLE64(System.Int64)">
804
<summary>
805
Swap littleendian signed 64 to platform's native byte order.
806
</summary>
807
<remarks>Take a 64-bit signed value in littleendian format and convert it to the platform's native byte order.</remarks>
808
<param name="val">value to convert</param>
809
<returns>converted value.</returns>
810
</member>
811
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapUBE16(System.UInt16)">
812
<summary>
813
Swap bigendian unsigned 16 to platform's native byte order.
814
</summary>
815
<remarks>Take a 16-bit unsigned value in bigendian format and convert it to the platform's native byte order.</remarks>
816
<param name="val">value to convert</param>
817
<returns>converted value.</returns>
818
</member>
819
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapUBE32(System.UInt32)">
820
<summary>
821
Swap bigendian unsigned 32 to platform's native byte order.
822
</summary>
823
<remarks>Take a 32-bit unsigned value in bigendian format and convert it to the platform's native byte order.</remarks>
824
<param name="val">value to convert</param>
825
<returns>converted value.</returns>
826
</member>
827
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapUBE64(System.UInt64)">
828
<summary>
829
Swap bigendian unsigned 64 to platform's native byte order.
830
</summary>
831
<remarks>Take a 64-bit unsigned value in bigendian format and convert it to the platform's native byte order.</remarks>
832
<param name="val">value to convert</param>
833
<returns>converted value.</returns>
834
</member>
835
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapULE16(System.UInt16)">
836
<summary>
837
Swap littleendian unsigned 16 to platform's native byte order.
838
</summary>
839
<remarks>Take a 16-bit unsigned value in littleendian format and convert it to the platform's native byte order.</remarks>
840
<param name="val">value to convert</param>
841
<returns>converted value.</returns>
842
</member>
843
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapULE32(System.UInt32)">
844
<summary>
845
Swap littleendian unsigned 32 to platform's native byte order.
846
</summary>
847
<remarks>Take a 32-bit unsigned value in littleendian format and convert it to the platform's native byte order.</remarks>
848
<param name="val">value to convert</param>
849
<returns>converted value.</returns>
850
</member>
851
<member name="M:Tao.PhysFs.Fs.PHYSFS_swapULE64(System.UInt64)">
852
<summary>
853
Swap littleendian unsigned 64 to platform's native byte order.
854
</summary>
855
<remarks>Take a 64-bit unsigned value in littleendian format and convert it to the platform's native byte order.</remarks>
856
<param name="val">value to convert</param>
857
<returns>converted value.</returns>
858
</member>
859
<member name="M:Tao.PhysFs.Fs.PHYSFS_tell(System.IntPtr)">
860
<summary>
861
Determine current position within a PhysicsFS filehandle.
862
</summary>
863
<param name="handle">handle returned from PHYSFS_open*().</param>
864
<returns>offset in bytes from start of file. -1 if error occurred. Specifics of the error can be gleaned from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>.</returns>
865
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_seek(System.IntPtr,System.UInt64)"/>
866
</member>
867
<member name="M:Tao.PhysFs.Fs.PHYSFS_write(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)">
868
<summary>
869
Write data to a PhysicsFS filehandle.
870
</summary>
871
<remarks>The file must be opened for writing.</remarks>
872
<param name="handle">retval from <see cref="M:Tao.PhysFs.Fs.PHYSFS_openWrite(System.String)"/> or <see cref="M:Tao.PhysFs.Fs.PHYSFS_openAppend(System.String)"/>.</param>
873
<param name="buffer">buffer to store read data into.</param>
874
<param name="objSize">size in bytes of objects being read from (handle).</param>
875
<param name="objCount">number of (objSize) objects to read from (handle).</param>
876
<returns>number of objects written. <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>() can shed light on the reason this might be less than (objCount). -1 if complete failure.</returns>
877
</member>
878
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeSBE16(System.IntPtr,System.Int16)">
879
<summary>
880
Convert and write a signed 16-bit bigendian value.
881
</summary>
882
<remarks>Convenience function. Convert a signed 16-bit value from the platform's native byte order to bigendian and write it to a file.</remarks>
883
<param name="file">PhysicsFS file handle to which to write.</param>
884
<param name="val">Value to convert and write.</param>
885
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
886
</member>
887
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeSBE32(System.IntPtr,System.Int32)">
888
<summary>
889
Convert and write a signed 32-bit bigendian value.
890
</summary>
891
<remarks>Convenience function. Convert a signed 32-bit value from the platform's native byte order to bigendian and write it to a file.</remarks>
892
<param name="file">PhysicsFS file handle to which to write.</param>
893
<param name="val">Value to convert and write.</param>
894
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
895
</member>
896
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeSBE64(System.IntPtr,System.Int64)">
897
<summary>
898
Convert and write a signed 64-bit bigendian value.
899
</summary>
900
<remarks>Convenience function. Convert a signed 64-bit value from the platform's native byte order to bigendian and write it to a file.</remarks>
901
<param name="file">PhysicsFS file handle to which to write.</param>
902
<param name="val">Value to convert and write.</param>
903
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
904
</member>
905
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeSLE16(System.IntPtr,System.Int16)">
906
<summary>
907
Convert and write a signed 16-bit littleendian value.
908
</summary>
909
<remarks>Convenience function. Convert a signed 16-bit value from the platform's native byte order to littleendian and write it to a file.</remarks>
910
<param name="file">PhysicsFS file handle to which to write.</param>
911
<param name="val">Value to convert and write.</param>
912
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
913
</member>
914
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeSLE32(System.IntPtr,System.Int32)">
915
<summary>
916
Convert and write a signed 32-bit littleendian value.
917
</summary>
918
<remarks>Convenience function. Convert a signed 32-bit value from the platform's native byte order to littleendian and write it to a file.</remarks>
919
<param name="file">PhysicsFS file handle to which to write.</param>
920
<param name="val">Value to convert and write.</param>
921
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
922
</member>
923
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeSLE64(System.IntPtr,System.Int64)">
924
<summary>
925
Convert and write a signed 64-bit littleendian value.
926
</summary>
927
<remarks>Convenience function. Convert a signed 64-bit value from the platform's native byte order to littleendian and write it to a file.</remarks>
928
<param name="file">PhysicsFS file handle to which to write.</param>
929
<param name="val">Value to convert and write.</param>
930
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
931
</member>
932
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeUBE16(System.IntPtr,System.UInt16)">
933
<summary>
934
Convert and write an unsigned 16-bit bigendian value.
935
</summary>
936
<remarks>Convenience function. Convert an unsigned 16-bit value from the platform's native byte order to bigendian and write it to a file.</remarks>
937
<param name="file">PhysicsFS file handle to which to write.</param>
938
<param name="val">Value to convert and write.</param>
939
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
940
</member>
941
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeUBE32(System.IntPtr,System.UInt32)">
942
<summary>
943
Convert and write an unsigned 32-bit bigendian value.
944
</summary>
945
<remarks>Convenience function. Convert an unsigned 32-bit value from the platform's native byte order to bigendian and write it to a file.</remarks>
946
<param name="file">PhysicsFS file handle to which to write.</param>
947
<param name="val">Value to convert and write.</param>
948
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
949
</member>
950
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeUBE64(System.IntPtr,System.UInt64)">
951
<summary>
952
Convert and write an unsigned 64-bit bigendian value.
953
</summary>
954
<remarks>Convenience function. Convert an unsigned 64-bit value from the platform's native byte order to bigendian and write it to a file.</remarks>
955
<param name="file">PhysicsFS file handle to which to write.</param>
956
<param name="val">Value to convert and write.</param>
957
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
958
</member>
959
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeULE16(System.IntPtr,System.UInt16)">
960
<summary>
961
Convert and write an unsigned 16-bit littleendian value.
962
</summary>
963
<remarks>Convenience function. Convert an unsigned 16-bit value from the platform's native byte order to littleendian and write it to a file.</remarks>
964
<param name="file">PhysicsFS file handle to which to write.</param>
965
<param name="val">Value to convert and write.</param>
966
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
967
</member>
968
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeULE32(System.IntPtr,System.UInt32)">
969
<summary>
970
Convert and write an unsigned 32-bit littleendian value.
971
</summary>
972
<remarks>Convenience function. Convert an unsigned 32-bit value from the platform's native byte order to littleendian and write it to a file.</remarks>
973
<param name="file">PhysicsFS file handle to which to write.</param>
974
<param name="val">Value to convert and write.</param>
975
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
976
</member>
977
<member name="M:Tao.PhysFs.Fs.PHYSFS_writeULE64(System.IntPtr,System.UInt64)">
978
<summary>
979
Convert and write an unsigned 64-bit littleendian value.
980
</summary>
981
<remarks>Convenience function. Convert an unsigned 64-bit value from the platform's native byte order to littleendian and write it to a file.</remarks>
982
<param name="file">PhysicsFS file handle to which to write.</param>
983
<param name="val">Value to convert and write.</param>
984
<returns>zero on failure, non-zero on success. On failure, you can find out what went wrong from <see cref="M:Tao.PhysFs.Fs.PHYSFS_getLastError"/>().</returns>
985
</member>
986
<member name="T:Tao.PhysFs.Fs.PHYSFS_Version">
987
<summary>
988
Information the version of PhysicsFS in use.
989
</summary>
990
<remarks>Represents the library's version as three levels: major revision (increments with massive changes, additions, and enhancements), minor revision (increments with backwards-compatible changes to the major revision), and patchlevel (increments with fixes to the minor revision).</remarks>
991
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_VERSION(Tao.PhysFs.Fs.PHYSFS_Version@)"/>
992
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_getLinkedVersion(Tao.PhysFs.Fs.PHYSFS_Version@)"/>
993
</member>
994
<member name="F:Tao.PhysFs.Fs.PHYSFS_Version.major">
995
<summary>
996
major revision
997
</summary>
998
</member>
999
<member name="F:Tao.PhysFs.Fs.PHYSFS_Version.minor">
1000
<summary>
1001
minor revision
1002
</summary>
1003
</member>
1004
<member name="F:Tao.PhysFs.Fs.PHYSFS_Version.patch">
1005
<summary>
1006
patchlevel
1007
</summary>
1008
</member>
1009
<member name="M:Tao.PhysFs.Fs.PHYSFS_Version.ToString">
1010
<summary>
1011
Returns a string representation of the version number (x.x.x).
1012
</summary>
1013
<returns>A string representing the version.</returns>
1014
</member>
1015
<member name="T:Tao.PhysFs.Fs.PHYSFS_ArchiveInfo">
1016
<summary>
1017
Information on various PhysicsFS-supported archives.
1018
</summary>
1019
<remarks>
1020
This structure gives you details on what sort of archives are supported by this implementation of PhysicsFS. Archives tend to be things like ZIP files and such.
1021
<p>
1022
Not all binaries are created equal! PhysicsFS can be built with or without support for various archives. You can check with PHYSFS_supportedArchiveTypes() to see if your archive type is supported.
1023
</p>
1024
</remarks>
1025
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_supportedArchiveTypes"/>
1026
</member>
1027
<member name="M:Tao.PhysFs.Fs.PHYSFS_ArchiveInfo.#ctor(System.String,System.String,System.String,System.String)">
1028
<summary>
1029
Creates a PHYSFS_ArchiveInfo structure.
1030
</summary>
1031
<param name="extension">The archive's file extension.</param>
1032
<param name="description">The description of the archive.</param>
1033
<param name="author">Who created this implementation.</param>
1034
<param name="url">The URL of the archive.</param>
1035
</member>
1036
<member name="F:Tao.PhysFs.Fs.PHYSFS_ArchiveInfo.extension">
1037
<summary>
1038
Archive file extension: "ZIP", for example.
1039
</summary>
1040
</member>
1041
<member name="F:Tao.PhysFs.Fs.PHYSFS_ArchiveInfo.description">
1042
<summary>
1043
Human-readable archive description.
1044
</summary>
1045
</member>
1046
<member name="F:Tao.PhysFs.Fs.PHYSFS_ArchiveInfo.author">
1047
<summary>
1048
Person who did support for this archive.
1049
</summary>
1050
</member>
1051
<member name="F:Tao.PhysFs.Fs.PHYSFS_ArchiveInfo.url">
1052
<summary>
1053
URL related to this archive.
1054
</summary>
1055
</member>
1056
<member name="M:Tao.PhysFs.Fs.PHYSFS_ArchiveInfo.ToString">
1057
<summary>
1058
A human-readable representation of the archive info
1059
</summary>
1060
<returns></returns>
1061
</member>
1062
<member name="T:Tao.PhysFs.Fs.PHYSFS_ArchiveInfoInternal">
1063
<summary>
1064
Information on various PhysicsFS-supported archives.
1065
</summary>
1066
<remarks>
1067
This structure gives you details on what sort of archives are supported by this implementation of PhysicsFS. Archives tend to be things like ZIP files and such.
1068
<p>
1069
Not all binaries are created equal! PhysicsFS can be built with or without support for various archives. You can check with PHYSFS_supportedArchiveTypes() to see if your archive type is supported.
1070
</p>
1071
</remarks>
1072
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_supportedArchiveTypes"/>\
1073
</member>
1074
<member name="F:Tao.PhysFs.Fs.PHYSFS_ArchiveInfoInternal.extension">
1075
<summary>
1076
Archive file extension: "ZIP", for example.
1077
</summary>
1078
</member>
1079
<member name="F:Tao.PhysFs.Fs.PHYSFS_ArchiveInfoInternal.description">
1080
<summary>
1081
Human-readable archive description.
1082
</summary>
1083
</member>
1084
<member name="F:Tao.PhysFs.Fs.PHYSFS_ArchiveInfoInternal.author">
1085
<summary>
1086
Person who did support for this archive.
1087
</summary>
1088
</member>
1089
<member name="F:Tao.PhysFs.Fs.PHYSFS_ArchiveInfoInternal.url">
1090
<summary>
1091
URL related to this archive.
1092
</summary>
1093
</member>
1094
<member name="T:Tao.PhysFs.Fs.PHYSFS_File">
1095
<summary>
1096
A PhysicsFS file handle.
1097
</summary>
1098
<remarks>You get a pointer to one of these when you open a file for reading, writing, or appending via PhysicsFS.
1099
<p>As you can see from the lack of meaningful fields, you should treat this as opaque data. Don't try to manipulate the file handle, just pass the pointer you got, unmolested, to various PhysicsFS APIs.</p>
1100
</remarks>
1101
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openRead(System.String)"/>
1102
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openWrite(System.String)"/>
1103
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_openAppend(System.String)"/>
1104
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_close(System.IntPtr)"/>
1105
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_read(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>
1106
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_write(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32)"/>
1107
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_seek(System.IntPtr,System.UInt64)"/>
1108
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_tell(System.IntPtr)"/>
1109
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_eof(System.IntPtr)"/>
1110
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_setBuffer(System.IntPtr,System.UInt64)"/>
1111
<seealso cref="M:Tao.PhysFs.Fs.PHYSFS_flush(System.IntPtr)"/>
1112
</member>
1113
<member name="F:Tao.PhysFs.Fs.PHYSFS_File.opaque">
1114
<summary>
1115
That's all you get. Don't touch.
1116
</summary>
1117
</member>
1118
</members>
1119
</doc>
1120
1121