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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.22