/[TS3.SkuReader]/tags/1.0.0.13216/s3pi.Package.xml
ViewVC logotype

Contents of /tags/1.0.0.13216/s3pi.Package.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 82 - (show annotations) (download) (as text)
Mon Feb 10 21:30:07 2014 UTC (6 years ago) by william
File MIME type: text/xml
File size: 22861 byte(s)
tag 1.0.0.13216
1 <?xml version="1.0"?>
2 <doc>
3 <assembly>
4 <name>s3pi.Package</name>
5 </assembly>
6 <members>
7 <member name="T:s3pi.Package.Compression">
8 <summary>
9 Internal -- used by Package to handle compression routines
10 </summary>
11 </member>
12 <member name="T:s3pi.Package.PackageIndex">
13 <summary>
14 Internal -- used by Package to manage the package index
15 </summary>
16 </member>
17 <member name="M:s3pi.Package.PackageIndex.Sort(System.String)">
18 <summary>
19 Sort the index by the given field
20 </summary>
21 <param name="index">Field to sort by</param>
22 </member>
23 <member name="P:s3pi.Package.PackageIndex.Item(System.UInt32,System.UInt32,System.UInt64)">
24 <summary>
25 Return the index entry with the matching TGI
26 </summary>
27 <param name="type">Entry type</param>
28 <param name="group">Entry group</param>
29 <param name="instance">Entry instance</param>
30 <returns>Matching entry</returns>
31 </member>
32 <member name="P:s3pi.Package.PackageIndex.Item(s3pi.Interfaces.IResourceKey)">
33 <summary>
34 Returns requested resource, ignoring EPFlags
35 </summary>
36 <param name="rk">Resource key to find</param>
37 <returns>Matching entry</returns>
38 </member>
39 <member name="T:s3pi.Package.ResourceIndexEntry">
40 <summary>
41 Implementation of an index entry
42 </summary>
43 </member>
44 <member name="M:s3pi.Package.ResourceIndexEntry.Clone(System.EventHandler)">
45 <summary>
46 Get a copy of this element but with a new change event handler
47 </summary>
48 <param name="handler">Element change event handler</param>
49 <returns>Return a copy of this element but with a new change event handler</returns>
50 </member>
51 <member name="M:s3pi.Package.ResourceIndexEntry.Equals(s3pi.Interfaces.IResourceIndexEntry)">
52 <summary>
53 Indicates whether the current <see cref="T:s3pi.Package.ResourceIndexEntry"/> instance is equal to another <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> instance.
54 </summary>
55 <param name="other">An <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> instance to compare with this instance.</param>
56 <returns>true if the current instance is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
57 </member>
58 <member name="M:s3pi.Package.ResourceIndexEntry.GetHashCode">
59 <summary>
60 Returns the hash code for this instance.
61 </summary>
62 <returns>A 32-bit signed integer that is the hash code for this instance.</returns>
63 </member>
64 <member name="F:s3pi.Package.ResourceIndexEntry.indexEntry">
65 <summary>
66 The index entry data
67 </summary>
68 </member>
69 <member name="F:s3pi.Package.ResourceIndexEntry.ms">
70 <summary>
71 indexEntry as a (fixed size) memory stream
72 </summary>
73 </member>
74 <member name="F:s3pi.Package.ResourceIndexEntry.indexReader">
75 <summary>
76 Used to read from the indexEntry
77 </summary>
78 </member>
79 <member name="F:s3pi.Package.ResourceIndexEntry.indexWriter">
80 <summary>
81 Used to write to the indexEntry
82 </summary>
83 </member>
84 <member name="F:s3pi.Package.ResourceIndexEntry.isDeleted">
85 <summary>
86 True if the index entry should be treated as deleted
87 </summary>
88 </member>
89 <member name="F:s3pi.Package.ResourceIndexEntry.resourceStream">
90 <summary>
91 The uncompressed resource data associated with this index entry
92 (used to save having to uncompress the same entry again if it's requested more than once)
93 </summary>
94 </member>
95 <member name="M:s3pi.Package.ResourceIndexEntry.#ctor(System.Byte[])">
96 <summary>
97 Create a new index entry as a byte-for-byte copy of <paramref name="indexEntry"/>
98 </summary>
99 <param name="indexEntry">The source index entry</param>
100 </member>
101 <member name="M:s3pi.Package.ResourceIndexEntry.#ctor(System.Int32[],System.Int32[])">
102 <summary>
103 Create a new expanded index entry from the header and entry data passed
104 </summary>
105 <param name="header">header ints (same for each index entry); [0] is the index type</param>
106 <param name="entry">entry ints (specific to this entry)</param>
107 </member>
108 <member name="M:s3pi.Package.ResourceIndexEntry.Clone">
109 <summary>
110 Return a new index entry as a copy of this one
111 </summary>
112 <returns>A copy of this index entry</returns>
113 </member>
114 <member name="M:s3pi.Package.ResourceIndexEntry.Delete">
115 <summary>
116 Flag this index entry as deleted
117 </summary>
118 <remarks>Use APackage.RemoveResource() from user code</remarks>
119 </member>
120 <member name="P:s3pi.Package.ResourceIndexEntry.RecommendedApiVersion">
121 <summary>
122 The version of the API in use
123 </summary>
124 </member>
125 <member name="P:s3pi.Package.ResourceIndexEntry.ResourceType">
126 <summary>
127 The "type" of the resource
128 </summary>
129 </member>
130 <member name="P:s3pi.Package.ResourceIndexEntry.ResourceGroup">
131 <summary>
132 The "group" the resource is part of
133 </summary>
134 </member>
135 <member name="P:s3pi.Package.ResourceIndexEntry.Instance">
136 <summary>
137 The "instance" number of the resource
138 </summary>
139 </member>
140 <member name="P:s3pi.Package.ResourceIndexEntry.Chunkoffset">
141 <summary>
142 If the resource was read from a package, the location in the package the resource was read from
143 </summary>
144 </member>
145 <member name="P:s3pi.Package.ResourceIndexEntry.Filesize">
146 <summary>
147 The number of bytes the resource uses within the package
148 </summary>
149 </member>
150 <member name="P:s3pi.Package.ResourceIndexEntry.Memsize">
151 <summary>
152 The number of bytes the resource uses in memory
153 </summary>
154 </member>
155 <member name="P:s3pi.Package.ResourceIndexEntry.Compressed">
156 <summary>
157 0xFFFF if Filesize != Memsize, else 0x0000
158 </summary>
159 </member>
160 <member name="P:s3pi.Package.ResourceIndexEntry.Unknown2">
161 <summary>
162 Always 0x0001
163 </summary>
164 </member>
165 <member name="P:s3pi.Package.ResourceIndexEntry.Stream">
166 <summary>
167 A MemoryStream covering the index entry bytes
168 </summary>
169 </member>
170 <member name="P:s3pi.Package.ResourceIndexEntry.IsDeleted">
171 <summary>
172 True if the index entry has been deleted from the package index
173 </summary>
174 </member>
175 <member name="P:s3pi.Package.ResourceIndexEntry.ResourceStream">
176 <summary>
177 The uncompressed resource data associated with this index entry
178 (used to save having to uncompress the same entry again if it's requested more than once)
179 Setting the stream updates the Memsize
180 </summary>
181 <remarks>Use Package.ReplaceResource() from user code</remarks>
182 </member>
183 <member name="P:s3pi.Package.ResourceIndexEntry.IsDirty">
184 <summary>
185 True if the index entry should be treated as dirty - e.g. the ResourceStream has been replaced
186 </summary>
187 </member>
188 <member name="T:s3pi.Package.Package">
189 <summary>
190 Implementation of a package
191 </summary>
192 </member>
193 <member name="M:s3pi.Package.Package.SavePackage">
194 <summary>
195 Tell the package to save itself to wherever it believes it came from
196 </summary>
197 </member>
198 <member name="M:s3pi.Package.Package.SaveAs(System.IO.Stream)">
199 <summary>
200 Save the package to a given stream
201 </summary>
202 <param name="s">Stream to save to</param>
203 </member>
204 <member name="M:s3pi.Package.Package.SaveAs(System.String)">
205 <summary>
206 Save the package to a given file
207 </summary>
208 <param name="path">File to save to - will be overwritten or created</param>
209 </member>
210 <member name="M:s3pi.Package.Package.NewPackage(System.Int32)">
211 <summary>
212 Initialise a new, empty package and return the IPackage reference
213 </summary>
214 <param name="APIversion">(unused)</param>
215 <returns>IPackage reference to an empty package</returns>
216 </member>
217 <member name="M:s3pi.Package.Package.OpenPackage(System.Int32,System.String)">
218 <summary>
219 Open an existing package by filename, read only
220 </summary>
221 <param name="APIversion">(unused)</param>
222 <param name="packagePath">Fully qualified filename of the package</param>
223 <returns>IPackage reference to an existing package on disk</returns>
224 <exception cref="T:System.ArgumentNullException"><paramref name="packagePath"/> is null.</exception>
225 <exception cref="T:System.IO.FileNotFoundException">The file cannot be found.</exception>
226 <exception cref="T:System.IO.DirectoryNotFoundException"><paramref name="packagePath"/> is invalid, such as being on an unmapped drive.</exception>
227 <exception cref="T:System.IO.PathTooLongException">
228 <paramref name="packagePath"/>, or a component of the file name, exceeds the system-defined maximum length.
229 For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
230 </exception>
231 <exception cref="T:System.ArgumentException">
232 <paramref name="packagePath"/> is an empty string (""), contains only white space, or contains one or more invalid characters.
233 <br/>-or-<br/>
234 <paramref name="packagePath"/> refers to a non-file device, such as "con:", "com1:", "lpt1:", etc. in an NTFS environment.
235 </exception>
236 <exception cref="T:System.NotSupportedException">
237 <paramref name="packagePath"/> refers to a non-file device, such as "con:", "com1:", "lpt1:", etc. in a non-NTFS environment.
238 </exception>
239 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
240 <exception cref="T:System.IO.InvalidDataException">Thrown if the package header is malformed.</exception>
241 </member>
242 <member name="M:s3pi.Package.Package.OpenPackage(System.Int32,System.String,System.Boolean)">
243 <summary>
244 Open an existing package by filename, optionally readwrite
245 </summary>
246 <param name="APIversion">(unused)</param>
247 <param name="packagePath">Fully qualified filename of the package</param>
248 <param name="readwrite">True to indicate read/write access required</param>
249 <returns>IPackage reference to an existing package on disk</returns>
250 <exception cref="T:System.ArgumentNullException"><paramref name="packagePath"/> is null.</exception>
251 <exception cref="T:System.IO.FileNotFoundException">The file cannot be found.</exception>
252 <exception cref="T:System.IO.DirectoryNotFoundException"><paramref name="packagePath"/> is invalid, such as being on an unmapped drive.</exception>
253 <exception cref="T:System.IO.PathTooLongException">
254 <paramref name="packagePath"/>, or a component of the file name, exceeds the system-defined maximum length.
255 For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
256 </exception>
257 <exception cref="T:System.ArgumentException">
258 <paramref name="packagePath"/> is an empty string (""), contains only white space, or contains one or more invalid characters.
259 <br/>-or-<br/>
260 <paramref name="packagePath"/> refers to a non-file device, such as "con:", "com1:", "lpt1:", etc. in an NTFS environment.
261 </exception>
262 <exception cref="T:System.NotSupportedException">
263 <paramref name="packagePath"/> refers to a non-file device, such as "con:", "com1:", "lpt1:", etc. in a non-NTFS environment.
264 </exception>
265 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
266 <exception cref="T:System.UnauthorizedAccessException">
267 The access requested is not permitted by the operating system for <paramref name="packagePath"/>,
268 such as when access is ReadWrite and the file or directory is set for read-only access.
269 </exception>
270 <exception cref="T:System.IO.InvalidDataException">Thrown if the package header is malformed.</exception>
271 </member>
272 <member name="M:s3pi.Package.Package.ClosePackage(System.Int32,s3pi.Interfaces.IPackage)">
273 <summary>
274 Releases any internal references associated with the given package
275 </summary>
276 <param name="APIversion">(unused)</param>
277 <param name="pkg">IPackage reference to close</param>
278 </member>
279 <member name="M:s3pi.Package.Package.Find(System.UInt32,s3pi.Interfaces.IResourceIndexEntry)">
280 <summary>
281 Searches for an element that matches the conditions defined by <paramref name="flags"/> and <paramref name="values"/>,
282 and returns the first occurrence within the package index./>.
283 </summary>
284 <param name="flags">True bits enable matching against numerically equivalent <paramref name="values"/> entry</param>
285 <param name="values">Fields to compare against</param>
286 <returns>The first match, if any; otherwise null.</returns>
287 </member>
288 <member name="M:s3pi.Package.Package.Find(System.String[],s3pi.Interfaces.TypedValue[])">
289 <summary>
290 Searches for an element that matches the conditions defined by <paramref name="names"/> and <paramref name="values"/>,
291 and returns the first occurrence within the package index./>.
292 </summary>
293 <param name="names">Names of fields to compare</param>
294 <param name="values">Fields to compare against</param>
295 <returns>The first match, if any; otherwise null.</returns>
296 </member>
297 <member name="M:s3pi.Package.Package.Find(System.Predicate{s3pi.Interfaces.IResourceIndexEntry})">
298 <summary>
299 Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/>
300 for the first <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> that matches the conditions defined by
301 the <c>Predicate&lt;IResourceIndexEntry&gt;</c> <paramref name="Match"/>.
302 </summary>
303 <param name="Match"><c>Predicate&lt;IResourceIndexEntry&gt;</c> defining matching conditions.</param>
304 <returns>The first matching <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>, if any; otherwise null.</returns>
305 <remarks>Note that entries marked as deleted will not be returned.</remarks>
306 </member>
307 <member name="M:s3pi.Package.Package.FindAll(System.UInt32,s3pi.Interfaces.IResourceIndexEntry)">
308 <summary>
309 Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/>
310 for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by
311 <paramref name="flags"/> and <paramref name="values"/>.
312 </summary>
313 <param name="flags">True bits enable matching against numerically equivalent <paramref name="values"/> entry.</param>
314 <param name="values">Field values to compare against.</param>
315 <returns>An <c>IList&lt;IResourceIndexEntry&gt;</c> of zero or more matches.</returns>
316 </member>
317 <member name="M:s3pi.Package.Package.FindAll(System.String[],s3pi.Interfaces.TypedValue[])">
318 <summary>
319 Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/>
320 for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by
321 <paramref name="names"/> and <paramref name="values"/>.
322 </summary>
323 <param name="names">Names of <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> fields to compare.</param>
324 <param name="values">Field values to compare against.</param>
325 <returns>An <c>IList&lt;IResourceIndexEntry&gt;</c> of zero or more matches.</returns>
326 </member>
327 <member name="M:s3pi.Package.Package.FindAll(System.Predicate{s3pi.Interfaces.IResourceIndexEntry})">
328 <summary>
329 Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/>
330 for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by
331 the <c>Predicate&lt;IResourceIndexEntry&gt;</c> <paramref name="Match"/>.
332 </summary>
333 <param name="Match"><c>Predicate&lt;IResourceIndexEntry&gt;</c> defining matching conditions.</param>
334 <returns>Zero or more matches.</returns>
335 <remarks>Note that entries marked as deleted will not be returned.</remarks>
336 </member>
337 <member name="M:s3pi.Package.Package.AddResource(s3pi.Interfaces.IResourceKey,System.IO.Stream,System.Boolean)">
338 <summary>
339 Add a resource to the package
340 </summary>
341 <param name="rk">The resource key</param>
342 <param name="stream">The stream that contains the resource data</param>
343 <param name="rejectDups">If true, fail if the resource key already exists</param>
344 <returns>Null if rejectDups and the resource key exists; else the new IResourceIndexEntry</returns>
345 </member>
346 <member name="M:s3pi.Package.Package.ReplaceResource(s3pi.Interfaces.IResourceIndexEntry,s3pi.Interfaces.IResource)">
347 <summary>
348 Tell the package to replace the data for the resource indexed by <paramref name="rc"/>
349 with the data from the resource <paramref name="res"/>
350 </summary>
351 <param name="rc">Target resource index</param>
352 <param name="res">Source resource</param>
353 </member>
354 <member name="M:s3pi.Package.Package.DeleteResource(s3pi.Interfaces.IResourceIndexEntry)">
355 <summary>
356 Tell the package to delete the resource indexed by <paramref name="rc"/>
357 </summary>
358 <param name="rc">Target resource index</param>
359 </member>
360 <member name="M:s3pi.Package.Package.GetResource(s3pi.Interfaces.IResourceIndexEntry)">
361 <summary>
362 Used by WrapperDealer to get the data for a resource
363 </summary>
364 <param name="rc">IResourceIndexEntry of resource</param>
365 <returns>The resource data (uncompressed, if necessary)</returns>
366 </member>
367 <member name="P:s3pi.Package.Package.RecommendedApiVersion">
368 <summary>
369 The version of the API in use
370 </summary>
371 </member>
372 <member name="P:s3pi.Package.Package.Magic">
373 <summary>
374 Package header: "DBPF" bytes
375 </summary>
376 </member>
377 <member name="P:s3pi.Package.Package.Major">
378 <summary>
379 Package header: 0x00000002
380 </summary>
381 </member>
382 <member name="P:s3pi.Package.Package.Minor">
383 <summary>
384 Package header: 0x00000000
385 </summary>
386 </member>
387 <member name="P:s3pi.Package.Package.Unknown1">
388 <summary>
389 Package header: unused
390 </summary>
391 </member>
392 <member name="P:s3pi.Package.Package.Indexcount">
393 <summary>
394 Package header: number of entries in the package index
395 </summary>
396 </member>
397 <member name="P:s3pi.Package.Package.Unknown2">
398 <summary>
399 Package header: unused
400 </summary>
401 </member>
402 <member name="P:s3pi.Package.Package.Indexsize">
403 <summary>
404 Package header: index size on disk in bytes
405 </summary>
406 </member>
407 <member name="P:s3pi.Package.Package.Unknown3">
408 <summary>
409 Package header: unused
410 </summary>
411 </member>
412 <member name="P:s3pi.Package.Package.Indexversion">
413 <summary>
414 Package header: always 3?
415 </summary>
416 </member>
417 <member name="P:s3pi.Package.Package.Indexposition">
418 <summary>
419 Package header: index position in file
420 </summary>
421 </member>
422 <member name="P:s3pi.Package.Package.Unknown4">
423 <summary>
424 Package header: unused
425 </summary>
426 </member>
427 <member name="P:s3pi.Package.Package.HeaderStream">
428 <summary>
429 A MemoryStream covering the package header bytes
430 </summary>
431 </member>
432 <member name="P:s3pi.Package.Package.Indextype">
433 <summary>
434 Package index: the index format in use
435 </summary>
436 </member>
437 <member name="P:s3pi.Package.Package.GetResourceList">
438 <summary>
439 Package index: the index
440 </summary>
441 </member>
442 </members>
443 </doc>

  ViewVC Help
Powered by ViewVC 1.1.22