Diff of /trunk/cforge/packages/IronPython-2.7.7/Platforms/Net45/IronPython.Modules.xml [000000] .. [r31]  Maximize  Restore

Switch to unified view

a b/trunk/cforge/packages/IronPython-2.7.7/Platforms/Net45/IronPython.Modules.xml
1
<?xml version="1.0"?>
2
<doc>
3
    <assembly>
4
        <name>IronPython.Modules</name>
5
    </assembly>
6
    <members>
7
        <member name="M:IronPython.Modules.Bz2.Bz2Module.BZ2Compressor.GetLatestData">
8
            <summary>
9
            Copy the latest data from the memory buffer.
10
            
11
            This won't always contain data, because comrpessed data is only written after a block is filled.
12
            </summary>
13
            <returns></returns>
14
        </member>
15
        <member name="M:IronPython.Modules.Bz2.Bz2Module.BZ2Decompressor.AddData(System.Byte[])">
16
            <summary>
17
            Add data to the input buffer. This manipulates the position of the stream
18
            to make it appear to the BZip2 stream that nothing has actually changed.
19
            </summary>
20
            <param name="bytes">The data to append to the buffer.</param>
21
        </member>
22
        <member name="M:IronPython.Modules.Bz2.Bz2Module.ToArrayNoCopy(System.Collections.Generic.IList{System.Byte})">
23
            <summary>
24
            Try to convert IList(Of byte) to byte[] without copying, if possible.
25
            </summary>
26
            <param name="bytes"></param>
27
            <returns></returns>
28
        </member>
29
        <member name="T:IronPython.Modules.ResourceMetaPathImporter">
30
            <summary>
31
            Implementes a resource-based meta_path importer as described in PEP 302.
32
            </summary>
33
        </member>
34
        <member name="M:IronPython.Modules.ResourceMetaPathImporter.#ctor(System.Reflection.Assembly,System.String)">
35
            <summary>
36
            Instantiates a new meta_path importer using an embedded ZIP resource file.
37
            </summary>
38
            <param name="fromAssembly"></param>
39
            <param name="resourceName"></param>
40
        </member>
41
        <member name="M:IronPython.Modules.PythonCodecs.charmap_build(System.String)">
42
            <summary>
43
            Creates an optimized encoding mapping that can be consumed by an optimized version of charmap_encode.
44
            </summary>
45
        </member>
46
        <member name="T:IronPython.Modules.PythonCodecs.EncodingMap">
47
            <summary>
48
            Optimied encoding mapping that can be consumed by charmap_encode.
49
            </summary>
50
        </member>
51
        <member name="M:IronPython.Modules.PythonCodecs.charmap_decode(System.String,System.String,System.String)">
52
            <summary>
53
            Decodes the input string using the provided string mapping.
54
            </summary>
55
        </member>
56
        <member name="M:IronPython.Modules.PythonCodecs.charmap_encode(System.String,System.String,IronPython.Modules.PythonCodecs.EncodingMap)">
57
            <summary>
58
            Encodes the input string with the specified optimized encoding map.
59
            </summary>
60
        </member>
61
        <member name="T:IronPython.Modules.ModuleOps">
62
            <summary>
63
            Provides helper functions which need to be called from generated code to implement various 
64
            portions of modules.
65
            </summary>
66
        </member>
67
        <member name="T:IronPython.Modules.PythonIOModule.BytesIO">
68
            <summary>
69
            BytesIO([initializer]) -> object
70
            
71
            Create a buffered I/O implementation using an in-memory bytes
72
            buffer, ready for reading and writing.
73
            </summary>
74
        </member>
75
        <member name="M:IronPython.Modules.PythonIOModule.BytesIO.close(IronPython.Runtime.CodeContext)">
76
            <summary>
77
            close() -> None.  Disable all I/O operations.
78
            </summary>
79
        </member>
80
        <member name="P:IronPython.Modules.PythonIOModule.BytesIO.closed">
81
            <summary>
82
            True if the file is closed.
83
            </summary>
84
        </member>
85
        <member name="M:IronPython.Modules.PythonIOModule.BytesIO.getvalue">
86
            <summary>
87
            getvalue() -> bytes.
88
            
89
            Retrieve the entire contents of the BytesIO object.
90
            </summary>
91
        </member>
92
        <member name="M:IronPython.Modules.PythonIOModule.TextIOWrapper.ReadChunk(IronPython.Runtime.CodeContext)">
93
            <summary>
94
            Read and decode the next chunk from the buffered reader. Returns true if EOF was
95
            not reached. Places decoded string in _decodedChars.
96
            </summary>
97
        </member>
98
        <member name="M:IronPython.Modules.PythonIOModule.GetBytes(System.Object,System.String)">
99
            <summary>
100
            Convert string or bytes into bytes
101
            </summary>
102
        </member>
103
        <member name="M:IronPython.Modules.PythonIOModule.GetBytes(System.Object)">
104
            <summary>
105
            Convert most bytearray-like objects into IList of byte
106
            </summary>
107
        </member>
108
        <member name="M:IronPython.Modules.PythonIOModule.FileIO.StandardizeMode(System.String)">
109
            <summary>
110
            Remove all 'b's from mode string to simplify parsing
111
            </summary>
112
        </member>
113
        <member name="M:IronPython.Modules.PythonCollections.deque.WalkDeque(IronPython.Modules.PythonCollections.deque.DequeWalker)">
114
            <summary>
115
            Walks the queue calling back to the specified delegate for
116
            each populated index in the queue.
117
            </summary>
118
        </member>
119
        <member name="M:IronPython.Modules.PythonCopyReg.EnsureCallable(IronPython.Runtime.CodeContext,System.Object,System.String)">
120
            <summary>
121
            Throw TypeError with a specified message if object isn't callable.
122
            </summary>
123
        </member>
124
        <member name="M:IronPython.Modules.PythonCopyReg.GetCode(IronPython.Runtime.CodeContext,System.Object)">
125
            <summary>
126
            Convert object to ushort, throwing ValueError on overflow.
127
            </summary>
128
        </member>
129
        <member name="T:IronPython.Modules.PythonPickle.FileInput">
130
            <summary>
131
            Interface for "file-like objects" that implement the protocol needed by load() and friends.
132
            This enables the creation of thin wrappers that make fast .NET types and slow Python types look the same.
133
            </summary>
134
        </member>
135
        <member name="T:IronPython.Modules.PythonPickle.FileOutput">
136
            <summary>
137
            Interface for "file-like objects" that implement the protocol needed by dump() and friends.
138
            This enables the creation of thin wrappers that make fast .NET types and slow Python types look the same.
139
            </summary>
140
        </member>
141
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.SaveObject(IronPython.Modules.PythonPickle.PicklerObject,IronPython.Runtime.CodeContext,System.Object)">
142
            <summary>
143
            Call the appropriate reduce method for obj and pickle the object using
144
            the resulting data. Use the first available of
145
            copy_reg.dispatch_table[type(obj)], obj.__reduce_ex__, and obj.__reduce__.
146
            </summary>
147
        </member>
148
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.SaveReduce(IronPython.Runtime.CodeContext,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
149
            <summary>
150
            Pickle the result of a reduce function.
151
            
152
            Only context, obj, func, and reduceCallable are required; all other arguments may be null.
153
            </summary>
154
        </member>
155
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteFloatAsString(IronPython.Runtime.CodeContext,System.Object)">
156
            <summary>
157
            Write value in pickle decimalnl_short format.
158
            </summary>
159
        </member>
160
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteFloat64(IronPython.Runtime.CodeContext,System.Object)">
161
            <summary>
162
            Write value in pickle float8 format.
163
            </summary>
164
        </member>
165
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteUInt8(IronPython.Runtime.CodeContext,System.Object)">
166
            <summary>
167
            Write value in pickle uint1 format.
168
            </summary>
169
        </member>
170
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteUInt16(IronPython.Runtime.CodeContext,System.Object)">
171
            <summary>
172
            Write value in pickle uint2 format.
173
            </summary>
174
        </member>
175
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteInt32(IronPython.Runtime.CodeContext,System.Object)">
176
            <summary>
177
            Write value in pickle int4 format.
178
            </summary>
179
        </member>
180
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteIntAsString(IronPython.Runtime.CodeContext,System.Object)">
181
            <summary>
182
            Write value in pickle decimalnl_short format.
183
            </summary>
184
        </member>
185
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteIntAsString(IronPython.Runtime.CodeContext,System.Int32)">
186
            <summary>
187
            Write value in pickle decimalnl_short format.
188
            </summary>
189
        </member>
190
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteLongAsString(IronPython.Runtime.CodeContext,System.Object)">
191
            <summary>
192
            Write value in pickle decimalnl_long format.
193
            </summary>
194
        </member>
195
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteUnicodeStringRaw(IronPython.Runtime.CodeContext,System.Object)">
196
            <summary>
197
            Write value in pickle unicodestringnl format.
198
            </summary>
199
        </member>
200
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteUnicodeStringUtf8(IronPython.Runtime.CodeContext,System.Object)">
201
            <summary>
202
            Write value in pickle unicodestring4 format.
203
            </summary>
204
        </member>
205
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteStringPair(IronPython.Runtime.CodeContext,System.Object,System.Object)">
206
            <summary>
207
            Write value in pickle stringnl_noescape_pair format.
208
            </summary>
209
        </member>
210
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.IsUInt8(IronPython.Runtime.CodeContext,System.Object)">
211
            <summary>
212
            Return true if value is appropriate for formatting in pickle uint1 format.
213
            </summary>
214
        </member>
215
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.IsUInt16(IronPython.Runtime.CodeContext,System.Object)">
216
            <summary>
217
            Return true if value is appropriate for formatting in pickle uint2 format.
218
            </summary>
219
        </member>
220
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.IsInt32(IronPython.Runtime.CodeContext,System.Object)">
221
            <summary>
222
            Return true if value is appropriate for formatting in pickle int4 format.
223
            </summary>
224
        </member>
225
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.BatchAppends(IronPython.Runtime.CodeContext,System.Collections.IEnumerator)">
226
            <summary>
227
            Emit a series of opcodes that will set append all items indexed by iter
228
            to the object at the top of the stack. Use APPENDS if possible, but
229
            append no more than BatchSize items at a time.
230
            </summary>
231
        </member>
232
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.BatchSetItems(IronPython.Runtime.CodeContext,IronPython.Runtime.PythonDictionary)">
233
            <summary>
234
            Emit a series of opcodes that will set all (key, value) pairs indexed by
235
            iter in the object at the top of the stack. Use SETITEMS if possible,
236
            but append no more than BatchSize items at a time.
237
            </summary>
238
        </member>
239
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.BatchSetItems(IronPython.Runtime.CodeContext,System.Collections.IEnumerator)">
240
            <summary>
241
            Emit a series of opcodes that will set all (key, value) pairs indexed by
242
            iter in the object at the top of the stack. Use SETITEMS if possible,
243
            but append no more than BatchSize items at a time.
244
            </summary>
245
        </member>
246
        <member name="M:IronPython.Modules.PythonPickle.PicklerObject.FindModuleForGlobal(IronPython.Runtime.CodeContext,System.Object,System.Object)">
247
            <summary>
248
            Find the module for obj and ensure that obj is reachable in that module by the given name.
249
            
250
            Throw PicklingError if any of the following are true:
251
             - The module couldn't be determined.
252
             - The module couldn't be loaded.
253
             - The given name doesn't exist in the module.
254
             - The given name is a different object than obj.
255
            
256
            Otherwise, return the name of the module.
257
            
258
            To determine which module obj lives in, obj.__module__ is used if available. The
259
            module named by obj.__module__ is loaded if needed. If obj has no __module__
260
            attribute, then each loaded module is searched. If a loaded module has an
261
            attribute with the given name, and that attribute is the same object as obj,
262
            then that module is used.
263
            </summary>
264
        </member>
265
        <member name="M:IronPython.Modules.PythonPickle.UnpicklerObject.SetItems(IronPython.Runtime.PythonDictionary,System.Int32)">
266
            <summary>
267
            Interpret everything from markIndex to the top of the stack as a sequence
268
            of key, value, key, value, etc. Set dict[key] = value for each. Pop
269
            everything from markIndex up when done.
270
            </summary>
271
        </member>
272
        <member name="M:IronPython.Modules.PythonDateTime.date.CheckType(System.Object,System.Boolean)">
273
            <summary>
274
            Used to check the type to see if we can do a comparison.  Returns true if we can
275
            or false if we should return NotImplemented.  May throw if the type's really wrong.
276
            </summary>
277
        </member>
278
        <member name="M:IronPython.Modules.PythonDateTime.time.CompareTo(System.Object)">
279
            <summary>
280
            Helper function for doing the comparisons.  time has no __cmp__ method
281
            </summary>
282
        </member>
283
        <member name="T:IronPython.Modules.PythonIterTools.IterBase">
284
            <summary>
285
            Base class used for iterator wrappers.
286
            </summary>
287
        </member>
288
        <member name="M:IronPython.Modules.PythonCsvModule.GetDialects(IronPython.Runtime.CodeContext)">
289
            <summary>
290
            Returns the dialects from the code context.
291
            </summary>
292
            <param name="context"></param>
293
            <returns></returns>
294
        </member>
295
        <member name="M:IronPython.Modules.PythonLocale.LocaleInfo.CreateConventionsDict">
296
            <summary>
297
            Populates the given directory w/ the locale information from the given
298
            CultureInfo.
299
            </summary>
300
        </member>
301
        <member name="M:IronPython.Modules.PythonMath.erf(System.Double)">
302
            <summary>
303
            Error function on real values
304
            </summary>
305
        </member>
306
        <member name="M:IronPython.Modules.PythonMath.erfc(System.Double)">
307
            <summary>
308
            Complementary error function on real values: erfc(x) =  1 - erf(x)
309
            </summary>
310
        </member>
311
        <member name="M:IronPython.Modules.PythonMath.gamma(System.Double)">
312
            <summary>
313
            Gamma function on real values
314
            </summary>
315
        </member>
316
        <member name="M:IronPython.Modules.PythonMath.lgamma(System.Double)">
317
            <summary>
318
            Natural log of absolute value of Gamma function
319
            </summary>
320
        </member>
321
        <member name="M:IronPython.Modules.PythonNT.access(IronPython.Runtime.CodeContext,System.String,System.Int32)">
322
            <summary>
323
            Checks for the specific permissions, provided by the mode parameter, are available for the provided path.  Permissions can be:
324
            
325
            F_OK: Check to see if the file exists
326
            R_OK | W_OK | X_OK: Check for the specific permissions.  Only W_OK is respected.
327
            </summary>
328
        </member>
329
        <member name="F:IronPython.Modules.PythonNT.environ">
330
            <summary>
331
            single instance of environment dictionary is shared between multiple runtimes because the environment
332
            is shared by multiple runtimes.
333
            </summary>
334
        </member>
335
        <member name="M:IronPython.Modules.PythonNT.lstat(System.String)">
336
            <summary>
337
            lstat(path) -> stat result 
338
            Like stat(path), but do not follow symbolic links.
339
            </summary>
340
        </member>
341
        <member name="M:IronPython.Modules.PythonNT.spawnl(IronPython.Runtime.CodeContext,System.Int32,System.String,System.Object[])">
342
            <summary>
343
            spawns a new process.
344
            
345
            If mode is nt.P_WAIT then then the call blocks until the process exits and the return value
346
            is the exit code.
347
            
348
            Otherwise the call returns a handle to the process.  The caller must then call nt.waitpid(pid, options)
349
            to free the handle and get the exit code of the process.  Failure to call nt.waitpid will result
350
            in a handle leak.
351
            </summary>
352
        </member>
353
        <member name="M:IronPython.Modules.PythonNT.spawnle(IronPython.Runtime.CodeContext,System.Int32,System.String,System.Object[])">
354
            <summary>
355
            spawns a new process.
356
            
357
            If mode is nt.P_WAIT then then the call blocks until the process exits and the return value
358
            is the exit code.
359
            
360
            Otherwise the call returns a handle to the process.  The caller must then call nt.waitpid(pid, options)
361
            to free the handle and get the exit code of the process.  Failure to call nt.waitpid will result
362
            in a handle leak.
363
            </summary>
364
        </member>
365
        <member name="M:IronPython.Modules.PythonNT.spawnv(IronPython.Runtime.CodeContext,System.Int32,System.String,System.Object)">
366
            <summary>
367
            spawns a new process.
368
            
369
            If mode is nt.P_WAIT then then the call blocks until the process exits and the return value
370
            is the exit code.
371
            
372
            Otherwise the call returns a handle to the process.  The caller must then call nt.waitpid(pid, options)
373
            to free the handle and get the exit code of the process.  Failure to call nt.waitpid will result
374
            in a handle leak.
375
            </summary>
376
        </member>
377
        <member name="M:IronPython.Modules.PythonNT.spawnve(IronPython.Runtime.CodeContext,System.Int32,System.String,System.Object,System.Object)">
378
            <summary>
379
            spawns a new process.
380
            
381
            If mode is nt.P_WAIT then then the call blocks until the process exits and the return value
382
            is the exit code.
383
            
384
            Otherwise the call returns a handle to the process.  The caller must then call nt.waitpid(pid, options)
385
            to free the handle and get the exit code of the process.  Failure to call nt.waitpid will result
386
            in a handle leak.
387
            </summary>
388
        </member>
389
        <member name="M:IronPython.Modules.PythonNT.SetEnvironment(System.Collections.Specialized.StringDictionary,System.Object)">
390
            <summary>
391
            Copy elements from a Python mapping of dict environment variables to a StringDictionary.
392
            </summary>
393
        </member>
394
        <member name="M:IronPython.Modules.PythonNT.ArgumentsToString(IronPython.Runtime.CodeContext,System.Object)">
395
            <summary>
396
            Convert a sequence of args to a string suitable for using to spawn a process.
397
            </summary>
398
        </member>
399
        <member name="T:IronPython.Modules.PythonRegex">
400
            <summary>
401
            Python regular expression module.
402
            </summary>
403
        </member>
404
        <member name="T:IronPython.Modules.PythonRegex.RE_Pattern">
405
            <summary>
406
            Compiled reg-ex pattern
407
            </summary>
408
        </member>
409
        <member name="M:IronPython.Modules.PythonRegex.PreParseRegex(IronPython.Runtime.CodeContext,System.String)">
410
            <summary>
411
            Preparses a regular expression text returning a ParsedRegex class
412
            that can be used for further regular expressions.
413
            </summary>
414
        </member>
415
        <member name="M:IronPython.Modules.PythonSelect.ProcessSocketSequence(IronPython.Runtime.CodeContext,System.Object,IronPython.Runtime.List@,System.Collections.Generic.Dictionary{System.Net.Sockets.Socket,System.Object}@)">
416
            <summary>
417
            Process a sequence of objects that are compatible with ObjectToSocket(). Return two
418
            things as out params: an in-order List of sockets that correspond to the original
419
            objects in the passed-in sequence, and a mapping of these socket objects to their
420
            original objects.
421
            
422
            The socketToOriginal mapping is generated because the CPython select module supports
423
            passing to select either file descriptor numbers or an object with a fileno() method.
424
            We try to be faithful to what was originally requested when we return.
425
            </summary>
426
        </member>
427
        <member name="M:IronPython.Modules.PythonSelect.ObjectToSocket(IronPython.Runtime.CodeContext,System.Object)">
428
            <summary>
429
            Return the System.Net.Sockets.Socket object that corresponds to the passed-in
430
            object. obj can be a System.Net.Sockets.Socket, a PythonSocket.SocketObj, a
431
            long integer (representing a socket handle), or a Python object with a fileno()
432
            method (whose result is used to look up an existing PythonSocket.SocketObj,
433
            which is in turn converted to a Socket.
434
            </summary>
435
        </member>
436
        <member name="F:IronPython.Modules.PythonSocket.socket._handleToSocket">
437
            <summary>
438
            handleToSocket allows us to translate from Python's idea of a socket resource (file
439
            descriptor numbers) to .NET's idea of a socket resource (System.Net.Socket objects).
440
            In particular, this allows the select module to convert file numbers (as returned by
441
            fileno()) and convert them to Socket objects so that it can do something useful with them.
442
            </summary>
443
        </member>
444
        <member name="M:IronPython.Modules.PythonSocket.socket.HandleToSocket(System.Int64)">
445
            <summary>
446
            Return the internal System.Net.Sockets.Socket socket object associated with the given
447
            handle (as returned by GetHandle()), or null if no corresponding socket exists. This is
448
            primarily intended to be used by other modules (such as select) that implement
449
            networking primitives. User code should not normally need to call this function.
450
            </summary>
451
        </member>
452
        <member name="M:IronPython.Modules.PythonSocket.socket.#ctor(IronPython.Runtime.CodeContext,System.Net.Sockets.Socket)">
453
            <summary>
454
            Create a Python socket object from an existing .NET socket object
455
            (like one returned from Socket.Accept())
456
            </summary>
457
        </member>
458
        <member name="M:IronPython.Modules.PythonSocket.socket.Initialize(IronPython.Runtime.CodeContext,System.Net.Sockets.Socket)">
459
            <summary>
460
            Perform initialization common to all constructors
461
            </summary>
462
        </member>
463
        <member name="M:IronPython.Modules.PythonSocket.SignInsensitiveToInt32(System.Object)">
464
            <summary>
465
            Convert an object to a 32-bit integer. This adds two features to Converter.ToInt32:
466
              1. Sign is ignored. For example, 0xffff0000 converts to 4294901760, where Convert.ToInt32
467
                 would throw because 0xffff0000 is less than zero.
468
              2. Overflow exceptions are thrown. Converter.ToInt32 throws TypeError if x is
469
                 an integer, but is bigger than 32 bits. Instead, we throw OverflowException.
470
            </summary>
471
        </member>
472
        <member name="M:IronPython.Modules.PythonSocket.SignInsensitiveToInt16(System.Object)">
473
            <summary>
474
            Convert an object to a 16-bit integer. This adds two features to Converter.ToInt16:
475
              1. Sign is ignored. For example, 0xff00 converts to 65280, where Convert.ToInt16
476
                 would throw because signed 0xff00 is -256.
477
              2. Overflow exceptions are thrown. Converter.ToInt16 throws TypeError if x is
478
                 an integer, but is bigger than 16 bits. Instead, we throw OverflowException.
479
            </summary>
480
        </member>
481
        <member name="M:IronPython.Modules.PythonSocket.MakeException(IronPython.Runtime.CodeContext,System.Exception)">
482
            <summary>
483
            Return a standard socket exception (socket.error) whose message and error code come from a SocketException
484
            This will eventually be enhanced to generate the correct error type (error, herror, gaierror) based on the error code.
485
            </summary>
486
        </member>
487
        <member name="M:IronPython.Modules.PythonSocket.IPv6BytesToColonHex(System.Byte[])">
488
            <summary>
489
            Convert an IPv6 address byte array to a string in standard colon-hex notation.
490
            The .NET IPAddress.ToString() method uses dotted-quad for the last 32 bits,
491
            which differs from the normal Python implementation (but is allowed by the IETF);
492
            this method returns the standard (no dotted-quad) colon-hex form.
493
            </summary>
494
        </member>
495
        <member name="M:IronPython.Modules.PythonSocket.ConvertSpecialAddresses(System.String)">
496
            <summary>
497
            Handle conversion of "" to INADDR_ANY and "&lt;broadcast&gt;" to INADDR_BROADCAST.
498
            Otherwise returns host unchanged.
499
            </summary>
500
        </member>
501
        <member name="M:IronPython.Modules.PythonSocket.HostToAddress(IronPython.Runtime.CodeContext,System.String,System.Net.Sockets.AddressFamily)">
502
            <summary>
503
            Return the IP address associated with host, with optional address family checking.
504
            host may be either a name or an IP address (in string form).
505
            
506
            If family is non-null, a gaierror will be thrown if the host's address family is
507
            not the same as the specified family. gaierror is also raised if the hostname cannot be
508
            converted to an IP address (e.g. through a name lookup failure).
509
            </summary>
510
        </member>
511
        <member name="M:IronPython.Modules.PythonSocket.HostToAddresses(IronPython.Runtime.CodeContext,System.String,System.Net.Sockets.AddressFamily)">
512
            <summary>
513
            Return the IP address associated with host, with optional address family checking.
514
            host may be either a name or an IP address (in string form).
515
            
516
            If family is non-null, a gaierror will be thrown if the host's address family is
517
            not the same as the specified family. gaierror is also raised if the hostname cannot be
518
            converted to an IP address (e.g. through a name lookup failure).
519
            </summary>
520
        </member>
521
        <member name="M:IronPython.Modules.PythonSocket.RemoveLocalDomain(System.String)">
522
            <summary>
523
            Return fqdn, but with its domain removed if it's on the same domain as the local machine.
524
            </summary>
525
        </member>
526
        <member name="M:IronPython.Modules.PythonSocket.TupleToEndPoint(IronPython.Runtime.CodeContext,IronPython.Runtime.PythonTuple,System.Net.Sockets.AddressFamily,System.String@)">
527
            <summary>
528
            Convert a (host, port) tuple [IPv4] (host, port, flowinfo, scopeid) tuple [IPv6]
529
            to its corresponding IPEndPoint.
530
            
531
            Throws gaierror if host is not a valid address.
532
            Throws ArgumentTypeException if any of the following are true:
533
             - address does not have exactly two elements
534
             - address[0] is not a string
535
             - address[1] is not an int
536
            </summary>
537
        </member>
538
        <member name="M:IronPython.Modules.PythonSocket.EndPointToTuple(System.Net.IPEndPoint)">
539
            <summary>
540
            Convert an IPEndPoint to its corresponding (host, port) [IPv4] or (host, port, flowinfo, scopeid) [IPv6] tuple.
541
            Throws SocketException if the address family is other than IPv4 or IPv6.
542
            </summary>
543
        </member>
544
        <member name="T:IronPython.Modules.LocalOrArg">
545
            <summary>
546
            Wrapper class for emitting locals/variables during marshalling code gen.
547
            </summary>
548
        </member>
549
        <member name="T:IronPython.Modules.MemoryHolder">
550
            <summary>
551
            A wrapper around allocated memory to ensure it gets released and isn't accessed
552
            when it could be finalized.
553
            </summary>
554
        </member>
555
        <member name="M:IronPython.Modules.MemoryHolder.#ctor(System.Int32)">
556
            <summary>
557
            Creates a new MemoryHolder and allocates a buffer of the specified size.
558
            </summary>
559
        </member>
560
        <member name="M:IronPython.Modules.MemoryHolder.#ctor(System.IntPtr,System.Int32)">
561
            <summary>
562
            Creates a new MemoryHolder at the specified address which is not tracked
563
            by us and we will never free.
564
            </summary>
565
        </member>
566
        <member name="M:IronPython.Modules.MemoryHolder.#ctor(System.IntPtr,System.Int32,IronPython.Modules.MemoryHolder)">
567
            <summary>
568
            Creates a new MemoryHolder at the specified address which will keep alive the 
569
            parent memory holder.
570
            </summary>
571
        </member>
572
        <member name="P:IronPython.Modules.MemoryHolder.UnsafeAddress">
573
            <summary>
574
            Gets the address of the held memory.  The caller should ensure the MemoryHolder
575
            is always alive as long as the address will continue to be accessed.
576
            </summary>
577
        </member>
578
        <member name="P:IronPython.Modules.MemoryHolder.Objects">
579
            <summary>
580
            Gets a list of objects which need to be kept alive for this MemoryHolder to be 
581
            remain valid.
582
            </summary>
583
        </member>
584
        <member name="M:IronPython.Modules.MemoryHolder.AddObject(System.Object,System.Object)">
585
            <summary>
586
            Used to track the lifetime of objects when one memory region depends upon
587
            another memory region.  For example if you have an array of objects that
588
            each have an element which has it's own lifetime the array needs to keep
589
            the individual elements alive.
590
            
591
            The keys used here match CPython's keys as tested by CPython's test_ctypes. 
592
            Typically they are a string which is the array index, "ffffffff" when
593
            from_buffer is used, or when it's a simple type there's just a string
594
            instead of the full dictionary - we store that under the key "str".
595
            </summary>
596
        </member>
597
        <member name="M:IronPython.Modules.MemoryHolder.CopyFrom(System.IntPtr,System.IntPtr)">
598
            <summary>
599
            Copies the data in data into this MemoryHolder.
600
            </summary>
601
        </member>
602
        <member name="M:IronPython.Modules.MemoryHolder.CopyTo(IronPython.Modules.MemoryHolder,System.Int32,System.Int32)">
603
            <summary>
604
            Copies memory from one location to another keeping the associated memory holders alive during the
605
            operation.
606
            </summary>
607
        </member>
608
        <member name="T:IronPython.Modules.NativeFunctions">
609
            <summary>
610
            Native functions used for exposing ctypes functionality.
611
            </summary>
612
        </member>
613
        <member name="M:IronPython.Modules.NativeFunctions.Calloc(System.IntPtr)">
614
            <summary>
615
            Allocates memory that's zero-filled
616
            </summary>
617
        </member>
618
        <member name="M:IronPython.Modules.NativeFunctions.MemSet(System.IntPtr,System.Byte,System.IntPtr)">
619
            <summary>
620
            Helper function for implementing memset.  Could be more efficient if we 
621
            could P/Invoke or call some otherwise native code to do this.
622
            </summary>
623
        </member>
624
        <member name="T:IronPython.Modules.CTypes">
625
            <summary>
626
            Provides support for interop with native code from Python code.
627
            </summary>
628
            <summary>
629
            Provides support for interop with native code from Python code.
630
            </summary>
631
            <summary>
632
            Provides support for interop with native code from Python code.
633
            </summary>
634
            <summary>
635
            Provides support for interop with native code from Python code.
636
            </summary>
637
            <summary>
638
            Provides support for interop with native code from Python code.
639
            </summary>
640
            <summary>
641
            Provides support for interop with native code from Python code.
642
            </summary>
643
            <summary>
644
            Provides support for interop with native code from Python code.
645
            </summary>
646
            <summary>
647
            Provides support for interop with native code from Python code.
648
            </summary>
649
            <summary>
650
            Provides support for interop with native code from Python code.
651
            </summary>
652
            <summary>
653
            Provides support for interop with native code from Python code.
654
            </summary>
655
            <summary>
656
            Provides support for interop with native code from Python code.
657
            </summary>
658
            <summary>
659
            Provides support for interop with native code from Python code.
660
            </summary>
661
            <summary>
662
            Provides support for interop with native code from Python code.
663
            </summary>
664
            <summary>
665
            Provides support for interop with native code from Python code.
666
            </summary>
667
            <summary>
668
            Provides support for interop with native code from Python code.
669
            </summary>
670
            <summary>
671
            Provides support for interop with native code from Python code.
672
            </summary>
673
            <summary>
674
            Provides support for interop with native code from Python code.
675
            </summary>
676
            <summary>
677
            Provides support for interop with native code from Python code.
678
            </summary>
679
        </member>
680
        <member name="T:IronPython.Modules.CTypes.SimpleTypeKind">
681
            <summary>
682
            The enum used for tracking the various ctypes primitive types.
683
            </summary>
684
        </member>
685
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Char">
686
            <summary> 'c' </summary>
687
        </member>
688
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedByte">
689
            <summary> 'b' </summary>
690
        </member>
691
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedByte">
692
            <summary> 'B' </summary>
693
        </member>
694
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedShort">
695
            <summary> 'h' </summary>
696
        </member>
697
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedShort">
698
            <summary> 'H' </summary>
699
        </member>
700
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedInt">
701
            <summary> 'i' </summary>
702
        </member>
703
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedInt">
704
            <summary> 'I' </summary>
705
        </member>
706
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedLong">
707
            <summary> 'l' </summary>
708
        </member>
709
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedLong">
710
            <summary> 'L' </summary>
711
        </member>
712
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Single">
713
            <summary> 'f' </summary>
714
        </member>
715
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Double">
716
            <summary> 'd', 'g' </summary>
717
        </member>
718
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedLongLong">
719
            <summary> 'q' </summary>
720
        </member>
721
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedLongLong">
722
            <summary> 'Q' </summary>
723
        </member>
724
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Object">
725
            <summary> 'O' </summary>
726
        </member>
727
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Pointer">
728
            <summary> 'P' </summary>
729
        </member>
730
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.CharPointer">
731
            <summary> 'z' </summary>
732
        </member>
733
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.WCharPointer">
734
            <summary> 'Z' </summary>
735
        </member>
736
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.WChar">
737
            <summary> 'u' </summary>
738
        </member>
739
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Boolean">
740
            <summary> '?' </summary>
741
        </member>
742
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.VariantBool">
743
            <summary> 'v' </summary>
744
        </member>
745
        <member name="F:IronPython.Modules.CTypes.SimpleTypeKind.BStr">
746
            <summary> 'X' </summary>
747
        </member>
748
        <member name="P:IronPython.Modules.CTypes._cast_addr">
749
            <summary>
750
            Gets a function which casts the specified memory.  Because this is used only
751
            w/ Python API we use a delegate as the return type instead of an actual address.
752
            </summary>
753
        </member>
754
        <member name="M:IronPython.Modules.CTypes.Cast(System.IntPtr,System.IntPtr,System.IntPtr)">
755
            <summary>
756
            Implementation of our cast function.  data is marshalled as a void*
757
            so it ends up as an address.  obj and type are marshalled as an object
758
            so we need to unmarshal them.
759
            </summary>
760
        </member>
761
        <member name="M:IronPython.Modules.CTypes.POINTER(IronPython.Runtime.CodeContext,IronPython.Runtime.Types.PythonType)">
762
            <summary>
763
            Returns a new type which represents a pointer given the existing type.
764
            </summary>
765
        </member>
766
        <member name="M:IronPython.Modules.CTypes.PyObj_FromPtr(System.IntPtr)">
767
            <summary>
768
            Converts an address acquired from PyObj_FromPtr or that has been
769
            marshaled as type 'O' back into an object.
770
            </summary>
771
        </member>
772
        <member name="M:IronPython.Modules.CTypes.PyObj_ToPtr(System.Object)">
773
            <summary>
774
            Converts an object into an opaque address which can be handed out to
775
            managed code.
776
            </summary>
777
        </member>
778
        <member name="M:IronPython.Modules.CTypes.Py_DECREF(System.Object)">
779
            <summary>
780
            Decreases the ref count on an object which has been increased with
781
            Py_INCREF.
782
            </summary>
783
        </member>
784
        <member name="M:IronPython.Modules.CTypes.Py_INCREF(System.Object)">
785
            <summary>
786
            Increases the ref count on an object ensuring that it will not be collected.
787
            </summary>
788
        </member>
789
        <member name="M:IronPython.Modules.CTypes.addressof(IronPython.Modules.CTypes.CData)">
790
            <summary>
791
            returns address of C instance internal buffer.
792
            
793
            It is the callers responsibility to ensure that the provided instance will 
794
            stay alive if memory in the resulting address is to be used later.
795
            </summary>
796
        </member>
797
        <member name="M:IronPython.Modules.CTypes.alignment(IronPython.Runtime.Types.PythonType)">
798
            <summary>
799
            Gets the required alignment of the given type.
800
            </summary>
801
        </member>
802
        <member name="M:IronPython.Modules.CTypes.alignment(System.Object)">
803
            <summary>
804
            Gets the required alignment of an object.
805
            </summary>
806
        </member>
807
        <member name="M:IronPython.Modules.CTypes.pointer(IronPython.Runtime.CodeContext,IronPython.Modules.CTypes.CData)">
808
            <summary>
809
            Returns a pointer instance for the given CData
810
            </summary>
811
        </member>
812
        <member name="P:IronPython.Modules.CTypes.DynamicModule">
813
            <summary>
814
            Gets the ModuleBuilder used to generate our unsafe call stubs into.
815
            </summary>
816
        </member>
817
        <member name="M:IronPython.Modules.CTypes.GetMarshalTypeFromSize(System.Int32)">
818
            <summary>
819
            Given a specific size returns a .NET type of the equivalent size that
820
            we can use when marshalling these values across calls.
821
            </summary>
822
        </member>
823
        <member name="M:IronPython.Modules.CTypes.GetFieldInfo(IronPython.Modules.CTypes.INativeType,System.Object,System.String@,IronPython.Modules.CTypes.INativeType@,System.Nullable{System.Int32}@)">
824
            <summary>
825
            Shared helper between struct and union for getting field info and validating it.
826
            </summary>
827
        </member>
828
        <member name="M:IronPython.Modules.CTypes.CheckBits(IronPython.Modules.CTypes.INativeType,IronPython.Runtime.PythonTuple)">
829
            <summary>
830
            Verifies that the provided bit field settings are valid for this type.
831
            </summary>
832
        </member>
833
        <member name="M:IronPython.Modules.CTypes.GetFieldsList(System.Object)">
834
            <summary>
835
            Shared helper to get the _fields_ list for struct/union and validate it.
836
            </summary>
837
        </member>
838
        <member name="M:IronPython.Modules.CTypes.StringAt(System.IntPtr,System.Int32)">
839
            <summary>
840
            Helper function for translating from memset to NT's FillMemory API.
841
            </summary>
842
        </member>
843
        <member name="M:IronPython.Modules.CTypes.WStringAt(System.IntPtr,System.Int32)">
844
            <summary>
845
            Helper function for translating from memset to NT's FillMemory API.
846
            </summary>
847
        </member>
848
        <member name="M:IronPython.Modules.CTypes.EmitCDataCreation(IronPython.Modules.CTypes.INativeType,System.Reflection.Emit.ILGenerator,System.Collections.Generic.List{System.Object},System.Int32)">
849
            <summary>
850
            Emits the marshalling code to create a CData object for reverse marshalling.
851
            </summary>
852
        </member>
853
        <member name="T:IronPython.Modules.CTypes.ArrayType">
854
            <summary>
855
            The meta class for ctypes array instances.
856
            </summary>
857
        </member>
858
        <member name="M:IronPython.Modules.CTypes.ArrayType.from_param(System.Object)">
859
            <summary>
860
            Converts an object into a function call parameter.
861
            </summary>
862
        </member>
863
        <member name="T:IronPython.Modules.CTypes.CData">
864
            <summary>
865
            Base class for all ctypes interop types.
866
            </summary>
867
        </member>
868
        <member name="M:IronPython.Modules.CTypes._CFuncPtr.#ctor(IronPython.Runtime.PythonTuple)">
869
            <summary>
870
            Creates a new CFuncPtr object from a tuple.  The 1st element of the
871
            tuple is the ordinal or function name.  The second is an object with
872
            a _handle property.  The _handle property is the handle of the module
873
            from which the function will be loaded.
874
            </summary>
875
        </member>
876
        <member name="M:IronPython.Modules.CTypes._CFuncPtr.#ctor(System.Int32,System.String)">
877
            <summary>
878
            Creates a new CFuncPtr which calls a COM method.
879
            </summary>
880
        </member>
881
        <member name="M:IronPython.Modules.CTypes._CFuncPtr.#ctor(System.Int32)">
882
            <summary>
883
            Creates a new CFuncPtr with the specfied address.
884
            </summary>
885
        </member>
886
        <member name="M:IronPython.Modules.CTypes._CFuncPtr.#ctor(System.Numerics.BigInteger)">
887
            <summary>
888
            Creates a new CFuncPtr with the specfied address.
889
            </summary>
890
        </member>
891
        <member name="M:IronPython.Modules.CTypes._CFuncPtr.Meta.AddKeepAlives(IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller[],System.Collections.Generic.List{System.Linq.Expressions.Expression})">
892
            <summary>
893
            we need to keep alive any methods which have arguments for the duration of the
894
            call.  Otherwise they could be collected on the finalizer thread before we come back.
895
            </summary>
896
        </member>
897
        <member name="M:IronPython.Modules.CTypes._CFuncPtr.Meta.CreateInteropInvoker(System.Runtime.InteropServices.CallingConvention,IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller[],IronPython.Modules.CTypes.INativeType,System.Boolean,System.Collections.Generic.List{System.Object})">
898
            <summary>
899
            Creates a method for calling with the specified signature.  The returned method has a signature
900
            of the form:
901
            
902
            (IntPtr funcAddress, arg0, arg1, ..., object[] constantPool)
903
            
904
            where IntPtr is the address of the function to be called.  The arguments types are based upon
905
            the types that the ArgumentMarshaller requires.
906
            </summary>
907
        </member>
908
        <member name="T:IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller">
909
            <summary>
910
            Base class for marshalling arguments from the user provided value to the
911
            call stub.  This class provides the logic for creating the call stub and
912
            calling it.
913
            </summary>
914
        </member>
915
        <member name="M:IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller.EmitCallStubArgument(System.Reflection.Emit.ILGenerator,System.Int32,System.Collections.Generic.List{System.Object},System.Int32)">
916
            <summary>
917
            Emits the IL to get the argument for the call stub generated into
918
            a dynamic method.
919
            </summary>
920
        </member>
921
        <member name="P:IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller.ArgumentExpression">
922
            <summary>
923
            Gets the expression used to provide the argument.  This is the expression
924
            from an incoming DynamicMetaObject.
925
            </summary>
926
        </member>
927
        <member name="M:IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller.GetKeepAlive">
928
            <summary>
929
            Gets an expression which keeps alive the argument for the duration of the call.  
930
            
931
            Returns null if a keep alive is not necessary.
932
            </summary>
933
        </member>
934
        <member name="T:IronPython.Modules.CTypes._CFuncPtr.Meta.PrimitiveMarshaller">
935
            <summary>
936
            Provides marshalling of primitive values when the function type
937
            has no type information or when the user has provided us with
938
            an explicit cdata instance.
939
            </summary>
940
        </member>
941
        <member name="T:IronPython.Modules.CTypes._CFuncPtr.Meta.CDataMarshaller">
942
            <summary>
943
            Provides marshalling for when the function type provide argument information.
944
            </summary>
945
        </member>
946
        <member name="T:IronPython.Modules.CTypes._CFuncPtr.Meta.NativeArgumentMarshaller">
947
            <summary>
948
            Provides marshalling for when the user provides a native argument object
949
            (usually gotten by byref or pointer) and the function type has no type information.
950
            </summary>
951
        </member>
952
        <member name="T:IronPython.Modules.CTypes.CFuncPtrType">
953
            <summary>
954
            The meta class for ctypes function pointer instances.
955
            </summary>
956
        </member>
957
        <member name="M:IronPython.Modules.CTypes.CFuncPtrType.from_param(System.Object)">
958
            <summary>
959
            Converts an object into a function call parameter.
960
            </summary>
961
        </member>
962
        <member name="T:IronPython.Modules.CTypes.Field">
963
            <summary>
964
            Fields are created when a Structure is defined and provide
965
            introspection of the structure.
966
            </summary>
967
        </member>
968
        <member name="M:IronPython.Modules.CTypes.Field.ExtractBits(System.Object)">
969
            <summary>
970
            Called for fields which have been limited to a range of bits.  Given the
971
            value for the full type this extracts the individual bits.
972
            </summary>
973
        </member>
974
        <member name="M:IronPython.Modules.CTypes.Field.SetBitsValue(IronPython.Modules.MemoryHolder,System.Int32,System.Object)">
975
            <summary>
976
            Called for fields which have been limited to a range of bits.  Sets the 
977
            specified value into the bits for the field.
978
            </summary>
979
        </member>
980
        <member name="T:IronPython.Modules.CTypes.INativeType">
981
            <summary>
982
            Common functionality that all of the meta classes provide which is part of
983
            our implementation.  This is used to implement the serialization/deserialization
984
            of values into/out of memory, emit the marshalling logic for call stubs, and
985
            provide common information (size/alignment) for the types.
986
            </summary>
987
        </member>
988
        <member name="P:IronPython.Modules.CTypes.INativeType.Size">
989
            <summary>
990
            Gets the native size of the type
991
            </summary>
992
        </member>
993
        <member name="P:IronPython.Modules.CTypes.INativeType.Alignment">
994
            <summary>
995
            Gets the required alignment for the type
996
            </summary>
997
        </member>
998
        <member name="M:IronPython.Modules.CTypes.INativeType.GetValue(IronPython.Modules.MemoryHolder,System.Object,System.Int32,System.Boolean)">
999
            <summary>
1000
            Deserialized the value of this type from the given address at the given
1001
            offset.  Any new objects which are created will keep the provided 
1002
            MemoryHolder alive.
1003
            
1004
            raw determines if the cdata is returned or if the primitive value is
1005
            returned.  This is only applicable for subtypes of simple cdata types.
1006
            </summary>
1007
        </member>
1008
        <member name="M:IronPython.Modules.CTypes.INativeType.SetValue(IronPython.Modules.MemoryHolder,System.Int32,System.Object)">
1009
            <summary>
1010
            Serializes the provided value into the specified address at the given
1011
            offset.
1012
            </summary>
1013
        </member>
1014
        <member name="M:IronPython.Modules.CTypes.INativeType.GetNativeType">
1015
            <summary>
1016
            Gets the .NET type which is used when calling or returning the value
1017
            from native code.
1018
            </summary>
1019
        </member>
1020
        <member name="M:IronPython.Modules.CTypes.INativeType.GetPythonType">
1021
            <summary>
1022
            Gets the .NET type which the native type is converted into when going to Python
1023
            code.  This is usually int, BigInt, double, object, or a CData type.
1024
            </summary>
1025
        </member>
1026
        <member name="M:IronPython.Modules.CTypes.INativeType.EmitMarshalling(System.Reflection.Emit.ILGenerator,IronPython.Modules.LocalOrArg,System.Collections.Generic.List{System.Object},System.Int32)">
1027
            <summary>
1028
            Emits marshalling of an object from Python to native code.  This produces the
1029
            native type from the Python type.
1030
            </summary>
1031
        </member>
1032
        <member name="M:IronPython.Modules.CTypes.INativeType.EmitReverseMarshalling(System.Reflection.Emit.ILGenerator,IronPython.Modules.LocalOrArg,System.Collections.Generic.List{System.Object},System.Int32)">
1033
            <summary>
1034
            Emits marshalling from native code to Python code This produces the python type 
1035
            from the native type.  This is used for return values and parameters 
1036
            to Python callable objects that are passed back out to native code.
1037
            </summary>
1038
        </member>
1039
        <member name="P:IronPython.Modules.CTypes.INativeType.TypeFormat">
1040
            <summary>
1041
            Returns a string which describes the type.  Used for _buffer_info implementation which
1042
            only exists for testing purposes.
1043
            </summary>
1044
        </member>
1045
        <member name="T:IronPython.Modules.CTypes.PointerType">
1046
            <summary>
1047
            The meta class for ctypes pointers.
1048
            </summary>
1049
        </member>
1050
        <member name="M:IronPython.Modules.CTypes.PointerType.from_param(IronPython.Modules.CTypes.Pointer)">
1051
            <summary>
1052
            Converts an object into a function call parameter.
1053
            </summary>
1054
        </member>
1055
        <member name="M:IronPython.Modules.CTypes.PointerType.from_address(System.Object)">
1056
            <summary>
1057
            Access an instance at the specified address
1058
            </summary>
1059
        </member>
1060
        <member name="T:IronPython.Modules.CTypes.SimpleType">
1061
            <summary>
1062
            The meta class for ctypes simple data types.  These include primitives like ints,
1063
            floats, etc... char/wchar pointers, and untyped pointers.
1064
            </summary>
1065
        </member>
1066
        <member name="M:IronPython.Modules.CTypes.SimpleType.from_param(System.Object)">
1067
            <summary>
1068
            Converts an object into a function call parameter.
1069
            </summary>
1070
        </member>
1071
        <member name="M:IronPython.Modules.CTypes.SimpleType.ReadChar(IronPython.Modules.MemoryHolder,System.Int32)">
1072
            <summary>
1073
            Helper function for reading char/wchar's.  This is used for reading from
1074
            arrays and pointers to avoid creating lots of 1-char strings.
1075
            </summary>
1076
        </member>
1077
        <member name="T:IronPython.Modules.CTypes.StructType">
1078
            <summary>
1079
            Meta class for structures.  Validates _fields_ on creation, provides factory
1080
            methods for creating instances from addresses and translating to parameters.
1081
            </summary>
1082
        </member>
1083
        <member name="M:IronPython.Modules.CTypes.StructType.from_param(System.Object)">
1084
            <summary>
1085
            Converts an object into a function call parameter.
1086
            
1087
            Structures just return themselves.
1088
            </summary>
1089
        </member>
1090
        <member name="M:IronPython.Modules.CTypes.StructType.EnsureSizeAndAlignment">
1091
            <summary>
1092
            If our size/alignment hasn't been initialized then grabs the size/alignment
1093
            from all of our base classes.  If later new _fields_ are added we'll be
1094
            initialized and these values will be replaced.
1095
            </summary>
1096
        </member>
1097
        <member name="T:IronPython.Modules.CTypes._Structure">
1098
            <summary>
1099
            Base class for data structures.  Subclasses can define _fields_ which 
1100
            specifies the in memory layout of the values.  Instances can then
1101
            be created with the initial values provided as the array.  The values
1102
            can then be accessed from the instance by field name.  The value can also
1103
            be passed to a foreign C API and the type can be used in other structures.
1104
            
1105
            class MyStructure(Structure):
1106
                _fields_ = [('a', c_int), ('b', c_int)]
1107
                
1108
            MyStructure(1, 2).a
1109
            MyStructure()
1110
            
1111
            class MyOtherStructure(Structure):
1112
                _fields_ = [('c', MyStructure), ('b', c_int)]
1113
                
1114
            MyOtherStructure((1, 2), 3)
1115
            MyOtherStructure(MyStructure(1, 2), 3)
1116
            </summary>
1117
        </member>
1118
        <member name="T:IronPython.Modules.CTypes.UnionType">
1119
            <summary>
1120
            The meta class for ctypes unions.
1121
            </summary>
1122
        </member>
1123
        <member name="M:IronPython.Modules.CTypes.UnionType.from_param(System.Object)">
1124
            <summary>
1125
            Converts an object into a function call parameter.
1126
            </summary>
1127
        </member>
1128
        <member name="T:IronPython.Modules.PythonStruct.FormatType">
1129
            <summary>
1130
            Enum which specifies the format type for a compiled struct
1131
            </summary>
1132
        </member>
1133
        <member name="T:IronPython.Modules.PythonStruct.Format">
1134
            <summary>
1135
            Struct used to store the format and the number of times it should be repeated.
1136
            </summary>
1137
        </member>
1138
        <member name="M:IronPython.Modules.PythonThread.interrupt_main(IronPython.Runtime.CodeContext)">
1139
            <summary>
1140
            Stops execution of Python or other .NET code on the main thread.  If the thread is
1141
            blocked in native code the thread will be interrupted after it returns back to Python
1142
            or other .NET code.  
1143
            </summary>
1144
        </member>
1145
        <member name="T:IronPython.Modules.PythonThread._local.ThreadLocalDictionaryStorage">
1146
            <summary>
1147
            Provides a dictionary storage implementation whose storage is local to
1148
            the thread.
1149
            </summary>
1150
        </member>
1151
        <member name="T:IronPython.Modules.PythonTime.FoundDateComponents">
1152
            <summary>
1153
            Represents the date components that we found while parsing the date.  Used for zeroing out values
1154
            which have different defaults from CPython.  Currently we only know that we need to do this for
1155
            the year.
1156
            </summary>
1157
        </member>
1158
        <member name="T:IronPython.Modules.xxsubtype">
1159
            <summary>
1160
            Samples on how to subtype built-in types from C#
1161
            </summary>
1162
        </member>
1163
        <member name="P:IronPython.Modules.xxsubtype.spamlist.state">
1164
            <summary>
1165
            an int variable for demonstration purposes
1166
            </summary>
1167
        </member>
1168
        <member name="P:IronPython.Modules.xxsubtype.spamdict.state">
1169
            <summary>
1170
            an int variable for demonstration purposes
1171
            </summary>
1172
        </member>
1173
        <member name="T:IronPython.Modules.FunctionTools.partial">
1174
            <summary>
1175
            Returns a new callable object with the provided initial set of arguments
1176
            bound to it.  Calling the new function then appends to the additional
1177
            user provided arguments.
1178
            </summary>
1179
        </member>
1180
        <member name="M:IronPython.Modules.FunctionTools.partial.#ctor(IronPython.Runtime.CodeContext,System.Object,System.Object[])">
1181
            <summary>
1182
            Creates a new partial object with the provided positional arguments.
1183
            </summary>
1184
        </member>
1185
        <member name="M:IronPython.Modules.FunctionTools.partial.#ctor(IronPython.Runtime.CodeContext,System.Object,System.Collections.Generic.IDictionary{System.Object,System.Object},System.Object[])">
1186
            <summary>
1187
            Creates a new partial object with the provided positional and keyword arguments.
1188
            </summary>
1189
        </member>
1190
        <member name="P:IronPython.Modules.FunctionTools.partial.func">
1191
            <summary>
1192
            Gets the function which will be called
1193
            </summary>
1194
        </member>
1195
        <member name="P:IronPython.Modules.FunctionTools.partial.args">
1196
            <summary>
1197
            Gets the initially provided positional arguments.
1198
            </summary>
1199
        </member>
1200
        <member name="P:IronPython.Modules.FunctionTools.partial.keywords">
1201
            <summary>
1202
            Gets the initially provided keyword arguments or None.
1203
            </summary>
1204
        </member>
1205
        <member name="P:IronPython.Modules.FunctionTools.partial.__dict__">
1206
            <summary>
1207
            Gets or sets the dictionary used for storing extra attributes on the partial object.
1208
            </summary>
1209
        </member>
1210
        <member name="M:IronPython.Modules.FunctionTools.partial.Call(IronPython.Runtime.CodeContext,System.Object[])">
1211
            <summary>
1212
            Calls func with the previously provided arguments and more positional arguments.
1213
            </summary>
1214
        </member>
1215
        <member name="M:IronPython.Modules.FunctionTools.partial.Call(IronPython.Runtime.CodeContext,System.Collections.Generic.IDictionary{System.Object,System.Object},System.Object[])">
1216
            <summary>
1217
            Calls func with the previously provided arguments and more positional arguments and keyword arguments.
1218
            </summary>
1219
        </member>
1220
        <member name="M:IronPython.Modules.FunctionTools.partial.SetMemberAfter(IronPython.Runtime.CodeContext,System.String,System.Object)">
1221
            <summary>
1222
            Operator method to set arbitrary members on the partial object.
1223
            </summary>
1224
        </member>
1225
        <member name="M:IronPython.Modules.FunctionTools.partial.GetBoundMember(IronPython.Runtime.CodeContext,System.String)">
1226
            <summary>
1227
            Operator method to get additional arbitrary members defined on the partial object.
1228
            </summary>
1229
        </member>
1230
        <member name="M:IronPython.Modules.FunctionTools.partial.DeleteMember(IronPython.Runtime.CodeContext,System.String)">
1231
            <summary>
1232
            Operator method to delete arbitrary members defined in the partial object.
1233
            </summary>
1234
        </member>
1235
        <member name="M:IronPython.Modules.PythonSsl.ReadInt(System.Byte[],System.Int32@)">
1236
            <summary>
1237
            BER encoding of an integer value is the number of bytes
1238
            required to represent the integer followed by the bytes
1239
            </summary>
1240
        </member>
1241
        <member name="M:IronPython.Modules.PythonSubprocess.DuplicateHandle(IronPython.Runtime.CodeContext,System.Numerics.BigInteger,IronPython.Modules.PythonSubprocessHandle,System.Numerics.BigInteger,System.Int32,System.Boolean,System.Object)">
1242
            <summary>
1243
            Duplicates a subprocess handle which was created for piping.
1244
            
1245
            This is only called when we're duplicating the handle to make it inheritable to the child process.  In CPython
1246
            the parent handle is always reliably garbage collected.  Because we know this handle is not going to be 
1247
            used we close the handle being duplicated.
1248
            </summary>
1249
        </member>
1250
        <member name="M:IronPython.Modules.PythonWeakRef.ConvertToWeakReferenceable(IronPython.Runtime.PythonContext,System.Object)">
1251
            <summary>
1252
            Wrapper provided for backwards compatibility.
1253
            </summary>
1254
        </member>
1255
        <member name="M:IronPython.Modules.PythonWeakRef.ref.__hash__(IronPython.Runtime.CodeContext)">
1256
            <summary>
1257
            Special hash function because IStructuralEquatable.GetHashCode is not allowed to throw.
1258
            </summary>
1259
        </member>
1260
        <member name="M:IronPython.Modules.PythonWeakRef.ref.RefEquals(System.Object,System.Object,System.Collections.IEqualityComparer)">
1261
            <summary>
1262
            Special equals because none of the special cases in Ops.Equals
1263
            are applicable here, and the reference equality check breaks some tests.
1264
            </summary>
1265
        </member>
1266
        <member name="M:IronPython.Modules.PythonWeakRef.weakproxy.GetObject">
1267
            <summary>
1268
            gets the object or throws a reference exception
1269
            </summary>
1270
        </member>
1271
        <member name="M:IronPython.Modules.PythonWeakRef.weakproxy.__eq__(System.Object)">
1272
            <summary>
1273
            Special equality function because IStructuralEquatable.Equals is not allowed to throw.
1274
            </summary>
1275
        </member>
1276
        <member name="M:IronPython.Modules.PythonWeakRef.weakcallableproxy.GetObject">
1277
            <summary>
1278
            gets the object or throws a reference exception
1279
            </summary>
1280
        </member>
1281
        <member name="M:IronPython.Modules.PythonWeakRef.weakcallableproxy.__eq__(System.Object)">
1282
            <summary>
1283
            Special equality function because IStructuralEquatable.Equals is not allowed to throw.
1284
            </summary>
1285
        </member>
1286
        <member name="M:IronPython.Modules.PythonWinReg.HKEYType.GetKey">
1287
            <summary>
1288
            Returns the underlying .NET RegistryKey
1289
            </summary>
1290
            <returns></returns>
1291
        </member>
1292
        <member name="F:IronPython.Runtime.ZipImportModule.zipimporter._search_order">
1293
            <summary>
1294
            zip_searchorder defines how we search for a module in the Zip
1295
            archive: we first search for a package __init__, then for
1296
            non-package .pyc, .pyo and .py entries. The .pyc and .pyo entries
1297
            are swapped by initzipimport() if we run in optimized mode. Also,
1298
            '/' is replaced by SEP there.
1299
            </summary>
1300
        </member>
1301
        <member name="M:IronPython.Runtime.ZipImportModule.zipimporter.GetData(IronPython.Runtime.CodeContext,System.String,IronPython.Runtime.PythonTuple)">
1302
            <summary>
1303
            Given a path to a Zip file and a toc_entry, return the (uncompressed)
1304
            data as a new reference.
1305
            </summary>
1306
            <param name="archive"></param>
1307
            <param name="toc_entry"></param>
1308
            <returns></returns>
1309
        </member>
1310
        <member name="M:IronPython.Runtime.ZipImportModule.zipimporter.GetCodeFromData(IronPython.Runtime.CodeContext,System.Boolean,System.Boolean,System.Int32,IronPython.Runtime.PythonTuple)">
1311
            <summary>
1312
            Return the code object for the module named by 'fullname' from the
1313
            Zip archive as a new reference.
1314
            </summary>
1315
            <param name="context"></param>
1316
            <param name="ispackage"></param>
1317
            <param name="isbytecode"></param>
1318
            <param name="mtime"></param>
1319
            <param name="toc_entry"></param>
1320
            <returns></returns>
1321
        </member>
1322
        <member name="M:IronPython.Runtime.ZipImportModule.zipimporter.ReadDirectory(IronPython.Runtime.CodeContext,System.String)">
1323
            <summary>
1324
            Given a path to a Zip archive, build a dict, mapping file names
1325
            (local to the archive, using SEP as a separator) to toc entries.
1326
            
1327
            A toc_entry is a tuple:
1328
            (__file__,      # value to use for __file__, available for all files
1329
             compress,      # compression kind; 0 for uncompressed
1330
             data_size,     # size of compressed data on disk
1331
             file_size,     # size of decompressed data
1332
             file_offset,   # offset of file header from start of archive
1333
             time,          # mod time of file (in dos format)
1334
             date,          # mod data of file (in dos format)
1335
             crc,           # crc checksum of the data
1336
             )
1337
            Directories can be recognized by the trailing SEP in the name,
1338
            data_size and file_offset are 0.
1339
            </summary>
1340
            <param name="archive"></param>
1341
            <returns></returns>
1342
        </member>
1343
        <member name="M:IronPython.Runtime.ZipImportModule.zipimporter.MakeFilename(IronPython.Runtime.CodeContext,System.String,System.String)">
1344
            <summary>
1345
            Given a (sub)modulename, write the potential file path in the
1346
            archive (without extension) to the path buffer. 
1347
            </summary>
1348
            <param name="prefix"></param>
1349
            <param name="name"></param>
1350
            <returns></returns>
1351
        </member>
1352
        <member name="M:IronPython.Runtime.ZipImportModule.zipimporter.GetModuleInfo(IronPython.Runtime.CodeContext,System.String)">
1353
            <summary>
1354
            Determines the type of module we have (package or module, or not found).
1355
            </summary>
1356
            <param name="context"></param>
1357
            <param name="fullname"></param>
1358
            <returns></returns>
1359
        </member>
1360
        <member name="T:IronPython.Runtime.ZipImportModule.SourceStringContentProvider">
1361
            <summary>
1362
            Provides a StreamContentProvider for a stream of content backed by a file on disk.
1363
            </summary>
1364
        </member>
1365
        <member name="P:Ionic.BZip2.BitWriter.RemainingBits">
1366
            <summary>
1367
              Delivers the remaining bits, left-aligned, in a byte.
1368
            </summary>
1369
            <remarks>
1370
              <para>
1371
                This is valid only if NumRemainingBits is less than 8;
1372
                in other words it is valid only after a call to Flush().
1373
              </para>
1374
            </remarks>
1375
        </member>
1376
        <member name="M:Ionic.BZip2.BitWriter.Reset">
1377
            <summary>
1378
              Reset the BitWriter.
1379
            </summary>
1380
            <remarks>
1381
              <para>
1382
                This is useful when the BitWriter writes into a MemoryStream, and
1383
                is used by a BZip2Compressor, which itself is re-used for multiple
1384
                distinct data blocks.
1385
              </para>
1386
            </remarks>
1387
        </member>
1388
        <member name="M:Ionic.BZip2.BitWriter.WriteBits(System.Int32,System.UInt32)">
1389
            <summary>
1390
              Write some number of bits from the given value, into the output.
1391
            </summary>
1392
            <remarks>
1393
              <para>
1394
                The nbits value should be a max of 25, for safety. For performance
1395
                reasons, this method does not check!
1396
              </para>
1397
            </remarks>
1398
        </member>
1399
        <member name="M:Ionic.BZip2.BitWriter.WriteByte(System.Byte)">
1400
            <summary>
1401
              Write a full 8-bit byte into the output.
1402
            </summary>
1403
        </member>
1404
        <member name="M:Ionic.BZip2.BitWriter.WriteInt(System.UInt32)">
1405
            <summary>
1406
              Write four 8-bit bytes into the output.
1407
            </summary>
1408
        </member>
1409
        <member name="M:Ionic.BZip2.BitWriter.Flush">
1410
            <summary>
1411
              Write all available byte-aligned bytes.
1412
            </summary>
1413
            <remarks>
1414
              <para>
1415
                This method writes no new output, but flushes any accumulated
1416
                bits. At completion, the accumulator may contain up to 7
1417
                bits.
1418
              </para>
1419
              <para>
1420
                This is necessary when re-assembling output from N independent
1421
                compressors, one for each of N blocks. The output of any
1422
                particular compressor will in general have some fragment of a byte
1423
                remaining. This fragment needs to be accumulated into the
1424
                parent BZip2OutputStream.
1425
              </para>
1426
            </remarks>
1427
        </member>
1428
        <member name="M:Ionic.BZip2.BitWriter.FinishAndPad">
1429
            <summary>
1430
              Writes all available bytes, and emits padding for the final byte as
1431
              necessary. This must be the last method invoked on an instance of
1432
              BitWriter.
1433
            </summary>
1434
        </member>
1435
        <member name="F:Ionic.BZip2.BZip2Compressor.increments">
1436
            Knuth's increments seem to work better than Incerpi-Sedgewick here.
1437
            Possibly because the number of elems to sort is usually small, typically
1438
            &lt;= 20.
1439
        </member>
1440
        <member name="M:Ionic.BZip2.BZip2Compressor.#ctor(Ionic.BZip2.BitWriter)">
1441
            <summary>
1442
              BZip2Compressor writes its compressed data out via a BitWriter. This
1443
              is necessary because BZip2 does byte shredding.
1444
            </summary>
1445
        </member>
1446
        <member name="P:Ionic.BZip2.BZip2Compressor.UncompressedBytes">
1447
            <summary>
1448
              The number of uncompressed bytes being held in the buffer.
1449
            </summary>
1450
            <remarks>
1451
              <para>
1452
                I am thinking this may be useful in a Stream that uses this
1453
                compressor class. In the Close() method on the stream it could
1454
                check this value to see if anything has been written at all.  You
1455
                may think the stream could easily track the number of bytes it
1456
                wrote, which would eliminate the need for this. But, there is the
1457
                case where the stream writes a complete block, and it is full, and
1458
                then writes no more. In that case the stream may want to check.
1459
              </para>
1460
            </remarks>
1461
        </member>
1462
        <member name="M:Ionic.BZip2.BZip2Compressor.Fill(System.Byte[],System.Int32,System.Int32)">
1463
            <summary>
1464
              Accept new bytes into the compressor data buffer
1465
            </summary>
1466
            <remarks>
1467
              <para>
1468
                This method does the first-level (cheap) run-length encoding, and
1469
                stores the encoded data into the rle block.
1470
              </para>
1471
            </remarks>
1472
        </member>
1473
        <member name="M:Ionic.BZip2.BZip2Compressor.write0(System.Byte)">
1474
             <summary>
1475
               Process one input byte into the block.
1476
             </summary>
1477
            
1478
             <remarks>
1479
               <para>
1480
                 To "process" the byte means to do the run-length encoding.
1481
                 There are 3 possible return values:
1482
            
1483
                    0 - the byte was not written, in other words, not
1484
                        encoded into the block. This happens when the
1485
                        byte b would require the start of a new run, and
1486
                        the block has no more room for new runs.
1487
            
1488
                    1 - the byte was written, and the block is not full.
1489
            
1490
                    2 - the byte was written, and the block is full.
1491
            
1492
               </para>
1493
             </remarks>
1494
             <returns>0 if the byte was not written, non-zero if written.</returns>
1495
        </member>
1496
        <member name="M:Ionic.BZip2.BZip2Compressor.AddRunToOutputBlock(System.Boolean)">
1497
             <summary>
1498
               Append one run to the output block.
1499
             </summary>
1500
            
1501
             <remarks>
1502
               <para>
1503
                 This compressor does run-length-encoding before BWT and etc. This
1504
                 method simply appends a run to the output block. The append always
1505
                 succeeds. The return value indicates whether the block is full:
1506
                 false (not full) implies that at least one additional run could be
1507
                 processed.
1508
               </para>
1509
             </remarks>
1510
             <returns>true if the block is now full; otherwise false.</returns>
1511
        </member>
1512
        <member name="M:Ionic.BZip2.BZip2Compressor.CompressAndWrite">
1513
            <summary>
1514
              Compress the data that has been placed (Run-length-encoded) into the
1515
              block. The compressed data goes into the CompressedBytes array.
1516
            </summary>
1517
            <remarks>
1518
              <para>
1519
                Side effects: 1.  fills the CompressedBytes array.  2. sets the
1520
                AvailableBytesOut property.
1521
              </para>
1522
            </remarks>
1523
        </member>
1524
        <member name="M:Ionic.BZip2.BZip2Compressor.mainSimpleSort(Ionic.BZip2.BZip2Compressor.CompressionState,System.Int32,System.Int32,System.Int32)">
1525
             This is the most hammered method of this class.
1526
            
1527
             <p>
1528
             This is the version using unrolled loops.
1529
             </p>
1530
        </member>
1531
        <member name="M:Ionic.BZip2.BZip2Compressor.mainQSort3(Ionic.BZip2.BZip2Compressor.CompressionState,System.Int32,System.Int32,System.Int32)">
1532
            Method "mainQSort3", file "blocksort.c", BZip2 1.0.2
1533
        </member>
1534
        <member name="F:Ionic.BZip2.BZip2Compressor.CompressionState.quadrant">
1535
            Array instance identical to sfmap, both are used only
1536
            temporarily and independently, so we do not need to allocate
1537
            additional memory.
1538
        </member>
1539
        <member name="T:Ionic.BZip2.BZip2InputStream">
1540
            <summary>
1541
              A read-only decorator stream that performs BZip2 decompression on Read.
1542
            </summary>
1543
        </member>
1544
        <member name="T:Ionic.BZip2.BZip2InputStream.CState">
1545
            <summary>
1546
              Compressor State
1547
            </summary>
1548
        </member>
1549
        <member name="M:Ionic.BZip2.BZip2InputStream.#ctor(System.IO.Stream)">
1550
            <summary>
1551
              Create a BZip2InputStream, wrapping it around the given input Stream.
1552
            </summary>
1553
            <remarks>
1554
              <para>
1555
                The input stream will be closed when the BZip2InputStream is closed.
1556
              </para>
1557
            </remarks>
1558
            <param name='input'>The stream from which to read compressed data</param>
1559
        </member>
1560
        <member name="M:Ionic.BZip2.BZip2InputStream.#ctor(System.IO.Stream,System.Boolean)">
1561
             <summary>
1562
               Create a BZip2InputStream with the given stream, and
1563
               specifying whether to leave the wrapped stream open when
1564
               the BZip2InputStream is closed.
1565
             </summary>
1566
             <param name='input'>The stream from which to read compressed data</param>
1567
             <param name='leaveOpen'>
1568
               Whether to leave the input stream open, when the BZip2InputStream closes.
1569
             </param>
1570
            
1571
             <example>
1572
            
1573
               This example reads a bzip2-compressed file, decompresses it,
1574
               and writes the decompressed data into a newly created file.
1575
            
1576
               <code>
1577
               var fname = "logfile.log.bz2";
1578
               using (var fs = File.OpenRead(fname))
1579
               {
1580
                   using (var decompressor = new Ionic.BZip2.BZip2InputStream(fs))
1581
                   {
1582
                       var outFname = fname + ".decompressed";
1583
                       using (var output = File.Create(outFname))
1584
                       {
1585
                           byte[] buffer = new byte[2048];
1586
                           int n;
1587
                           while ((n = decompressor.Read(buffer, 0, buffer.Length)) > 0)
1588
                           {
1589
                               output.Write(buffer, 0, n);
1590
                           }
1591
                       }
1592
                   }
1593
               }
1594
               </code>
1595
             </example>
1596
        </member>
1597
        <member name="M:Ionic.BZip2.BZip2InputStream.Read(System.Byte[],System.Int32,System.Int32)">
1598
             <summary>
1599
               Read data from the stream.
1600
             </summary>
1601
            
1602
             <remarks>
1603
               <para>
1604
                 To decompress a BZip2 data stream, create a <c>BZip2InputStream</c>,
1605
                 providing a stream that reads compressed data.  Then call Read() on
1606
                 that <c>BZip2InputStream</c>, and the data read will be decompressed
1607
                 as you read.
1608
               </para>
1609
            
1610
               <para>
1611
                 A <c>BZip2InputStream</c> can be used only for <c>Read()</c>, not for <c>Write()</c>.
1612
               </para>
1613
             </remarks>
1614
            
1615
             <param name="buffer">The buffer into which the read data should be placed.</param>
1616
             <param name="offset">the offset within that data array to put the first byte read.</param>
1617
             <param name="count">the number of bytes to read.</param>
1618
             <returns>the number of bytes actually read</returns>
1619
        </member>
1620
        <member name="M:Ionic.BZip2.BZip2InputStream.ReadByte">
1621
            <summary>
1622
              Read a single byte from the stream.
1623
            </summary>
1624
            <returns>the byte read from the stream, or -1 if EOF</returns>
1625
        </member>
1626
        <member name="P:Ionic.BZip2.BZip2InputStream.CanRead">
1627
            <summary>
1628
            Indicates whether the stream can be read.
1629
            </summary>
1630
            <remarks>
1631
            The return value depends on whether the captive stream supports reading.
1632
            </remarks>
1633
        </member>
1634
        <member name="P:Ionic.BZip2.BZip2InputStream.CanSeek">
1635
            <summary>
1636
            Indicates whether the stream supports Seek operations.
1637
            </summary>
1638
            <remarks>
1639
            Always returns false.
1640
            </remarks>
1641
        </member>
1642
        <member name="P:Ionic.BZip2.BZip2InputStream.CanWrite">
1643
            <summary>
1644
            Indicates whether the stream can be written.
1645
            </summary>
1646
            <remarks>
1647
            The return value depends on whether the captive stream supports writing.
1648
            </remarks>
1649
        </member>
1650
        <member name="M:Ionic.BZip2.BZip2InputStream.Flush">
1651
            <summary>
1652
            Flush the stream.
1653
            </summary>
1654
        </member>
1655
        <member name="P:Ionic.BZip2.BZip2InputStream.Length">
1656
            <summary>
1657
            Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
1658
            </summary>
1659
        </member>
1660
        <member name="P:Ionic.BZip2.BZip2InputStream.Position">
1661
             <summary>
1662
             The position of the stream pointer.
1663
             </summary>
1664
            
1665
             <remarks>
1666
               Setting this property always throws a <see
1667
               cref="T:System.NotImplementedException"/>. Reading will return the
1668
               total number of uncompressed bytes read in.
1669
             </remarks>
1670
        </member>
1671
        <member name="M:Ionic.BZip2.BZip2InputStream.Seek(System.Int64,System.IO.SeekOrigin)">
1672
            <summary>
1673
            Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
1674
            </summary>
1675
            <param name="offset">this is irrelevant, since it will always throw!</param>
1676
            <param name="origin">this is irrelevant, since it will always throw!</param>
1677
            <returns>irrelevant!</returns>
1678
        </member>
1679
        <member name="M:Ionic.BZip2.BZip2InputStream.SetLength(System.Int64)">
1680
            <summary>
1681
            Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
1682
            </summary>
1683
            <param name="value">this is irrelevant, since it will always throw!</param>
1684
        </member>
1685
        <member name="M:Ionic.BZip2.BZip2InputStream.Write(System.Byte[],System.Int32,System.Int32)">
1686
            <summary>
1687
              Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
1688
            </summary>
1689
            <param name='buffer'>this parameter is never used</param>
1690
            <param name='offset'>this parameter is never used</param>
1691
            <param name='count'>this parameter is never used</param>
1692
        </member>
1693
        <member name="M:Ionic.BZip2.BZip2InputStream.Dispose(System.Boolean)">
1694
            <summary>
1695
              Dispose the stream.
1696
            </summary>
1697
            <param name="disposing">
1698
              indicates whether the Dispose method was invoked by user code.
1699
            </param>
1700
        </member>
1701
        <member name="M:Ionic.BZip2.BZip2InputStream.GetBits(System.Int32)">
1702
            <summary>
1703
              Read n bits from input, right justifying the result.
1704
            </summary>
1705
            <remarks>
1706
              <para>
1707
                For example, if you read 1 bit, the result is either 0
1708
                or 1.
1709
              </para>
1710
            </remarks>
1711
            <param name ="n">
1712
              The number of bits to read, always between 1 and 32.
1713
            </param>
1714
        </member>
1715
        <member name="M:Ionic.BZip2.BZip2InputStream.hbCreateDecodeTables(System.Int32[],System.Int32[],System.Int32[],System.Char[],System.Int32,System.Int32,System.Int32)">
1716
            Called by createHuffmanDecodingTables() exclusively.
1717
        </member>
1718
        <member name="M:Ionic.BZip2.BZip2InputStream.createHuffmanDecodingTables(System.Int32,System.Int32)">
1719
            Called by recvDecodingTables() exclusively.
1720
        </member>
1721
        <member name="F:Ionic.BZip2.BZip2InputStream.DecompressionState.unzftab">
1722
            Freq table collected to save a pass over the data during
1723
            decompression.
1724
        </member>
1725
        <member name="M:Ionic.BZip2.BZip2InputStream.DecompressionState.initTT(System.Int32)">
1726
             Initializes the tt array.
1727
            
1728
             This method is called when the required length of the array is known.
1729
             I don't initialize it at construction time to avoid unneccessary
1730
             memory allocation when compressing small files.
1731
        </member>
1732
        <member name="M:Ionic.BZip2.BZip2InputStream.DumpState">
1733
            <summary>
1734
            Dump the current state of the decompressor, to restore it in case of an error.
1735
            This allows the decompressor to be essentially "rewound" and retried when more
1736
            data arrives.
1737
            
1738
            This is only used by IronPython.
1739
            </summary>
1740
            <returns>The current state.</returns>
1741
        </member>
1742
        <member name="M:Ionic.BZip2.BZip2InputStream.RestoreState(System.Object)">
1743
            <summary>
1744
            Restore the internal compressor state if an error occurred.
1745
            </summary>
1746
            <param name="o">The old state.</param>
1747
        </member>
1748
        <member name="T:Ionic.BZip2.BZip2OutputStream">
1749
            <summary>
1750
              A write-only decorator stream that compresses data as it is
1751
              written using the BZip2 algorithm.
1752
            </summary>
1753
        </member>
1754
        <member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream)">
1755
             <summary>
1756
               Constructs a new <c>BZip2OutputStream</c>, that sends its
1757
               compressed output to the given output stream.
1758
             </summary>
1759
            
1760
             <param name='output'>
1761
               The destination stream, to which compressed output will be sent.
1762
             </param>
1763
            
1764
             <example>
1765
            
1766
               This example reads a file, then compresses it with bzip2 file,
1767
               and writes the compressed data into a newly created file.
1768
            
1769
               <code>
1770
               var fname = "logfile.log";
1771
               using (var fs = File.OpenRead(fname))
1772
               {
1773
                   var outFname = fname + ".bz2";
1774
                   using (var output = File.Create(outFname))
1775
                   {
1776
                       using (var compressor = new Ionic.BZip2.BZip2OutputStream(output))
1777
                       {
1778
                           byte[] buffer = new byte[2048];
1779
                           int n;
1780
                           while ((n = fs.Read(buffer, 0, buffer.Length)) > 0)
1781
                           {
1782
                               compressor.Write(buffer, 0, n);
1783
                           }
1784
                       }
1785
                   }
1786
               }
1787
               </code>
1788
             </example>
1789
        </member>
1790
        <member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Int32)">
1791
            <summary>
1792
              Constructs a new <c>BZip2OutputStream</c> with specified blocksize.
1793
            </summary>
1794
            <param name = "output">the destination stream.</param>
1795
            <param name = "blockSize">
1796
              The blockSize in units of 100000 bytes.
1797
              The valid range is 1..9.
1798
            </param>
1799
        </member>
1800
        <member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Boolean)">
1801
            <summary>
1802
              Constructs a new <c>BZip2OutputStream</c>.
1803
            </summary>
1804
              <param name = "output">the destination stream.</param>
1805
            <param name = "leaveOpen">
1806
              whether to leave the captive stream open upon closing this stream.
1807
            </param>
1808
        </member>
1809
        <member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Int32,System.Boolean)">
1810
             <summary>
1811
               Constructs a new <c>BZip2OutputStream</c> with specified blocksize,
1812
               and explicitly specifies whether to leave the wrapped stream open.
1813
             </summary>
1814
            
1815
             <param name = "output">the destination stream.</param>
1816
             <param name = "blockSize">
1817
               The blockSize in units of 100000 bytes.
1818
               The valid range is 1..9.
1819
             </param>
1820
             <param name = "leaveOpen">
1821
               whether to leave the captive stream open upon closing this stream.
1822
             </param>
1823
        </member>
1824
        <member name="M:Ionic.BZip2.BZip2OutputStream.Flush">
1825
            <summary>
1826
              Flush the stream.
1827
            </summary>
1828
        </member>
1829
        <member name="P:Ionic.BZip2.BZip2OutputStream.BlockSize">
1830
            <summary>
1831
              The blocksize parameter specified at construction time.
1832
            </summary>
1833
        </member>
1834
        <member name="M:Ionic.BZip2.BZip2OutputStream.Write(System.Byte[],System.Int32,System.Int32)">
1835
             <summary>
1836
               Write data to the stream.
1837
             </summary>
1838
             <remarks>
1839
            
1840
             <para>
1841
               Use the <c>BZip2OutputStream</c> to compress data while writing:
1842
               create a <c>BZip2OutputStream</c> with a writable output stream.
1843
               Then call <c>Write()</c> on that <c>BZip2OutputStream</c>, providing
1844
               uncompressed data as input.  The data sent to the output stream will
1845
               be the compressed form of the input data.
1846
             </para>
1847
            
1848
             <para>
1849
               A <c>BZip2OutputStream</c> can be used only for <c>Write()</c> not for <c>Read()</c>.
1850
             </para>
1851
            
1852
             </remarks>
1853
            
1854
             <param name="buffer">The buffer holding data to write to the stream.</param>
1855
             <param name="offset">the offset within that data array to find the first byte to write.</param>
1856
             <param name="count">the number of bytes to write.</param>
1857
        </member>
1858
        <member name="P:Ionic.BZip2.BZip2OutputStream.CanRead">
1859
            <summary>
1860
            Indicates whether the stream can be read.
1861
            </summary>
1862
            <remarks>
1863
            The return value is always false.
1864
            </remarks>
1865
        </member>
1866
        <member name="P:Ionic.BZip2.BZip2OutputStream.CanSeek">
1867
            <summary>
1868
            Indicates whether the stream supports Seek operations.
1869
            </summary>
1870
            <remarks>
1871
            Always returns false.
1872
            </remarks>
1873
        </member>
1874
        <member name="P:Ionic.BZip2.BZip2OutputStream.CanWrite">
1875
            <summary>
1876
            Indicates whether the stream can be written.
1877
            </summary>
1878
            <remarks>
1879
            The return value should always be true, unless and until the
1880
            object is disposed and closed.
1881
            </remarks>
1882
        </member>
1883
        <member name="P:Ionic.BZip2.BZip2OutputStream.Length">
1884
            <summary>
1885
            Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
1886
            </summary>
1887
        </member>
1888
        <member name="P:Ionic.BZip2.BZip2OutputStream.Position">
1889
             <summary>
1890
             The position of the stream pointer.
1891
             </summary>
1892
            
1893
             <remarks>
1894
               Setting this property always throws a <see
1895
               cref="T:System.NotImplementedException"/>. Reading will return the
1896
               total number of uncompressed bytes written through.
1897
             </remarks>
1898
        </member>
1899
        <member name="M:Ionic.BZip2.BZip2OutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
1900
            <summary>
1901
            Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
1902
            </summary>
1903
            <param name="offset">this is irrelevant, since it will always throw!</param>
1904
            <param name="origin">this is irrelevant, since it will always throw!</param>
1905
            <returns>irrelevant!</returns>
1906
        </member>
1907
        <member name="M:Ionic.BZip2.BZip2OutputStream.SetLength(System.Int64)">
1908
            <summary>
1909
            Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
1910
            </summary>
1911
            <param name="value">this is irrelevant, since it will always throw!</param>
1912
        </member>
1913
        <member name="M:Ionic.BZip2.BZip2OutputStream.Read(System.Byte[],System.Int32,System.Int32)">
1914
            <summary>
1915
              Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
1916
            </summary>
1917
            <param name='buffer'>this parameter is never used</param>
1918
            <param name='offset'>this parameter is never used</param>
1919
            <param name='count'>this parameter is never used</param>
1920
            <returns>never returns anything; always throws</returns>
1921
        </member>
1922
        <member name="T:Ionic.BZip2.ParallelBZip2OutputStream">
1923
             <summary>
1924
               A write-only decorator stream that compresses data as it is
1925
               written using the BZip2 algorithm. This stream compresses by
1926
               block using multiple threads.
1927
             </summary>
1928
             <para>
1929
               This class performs BZIP2 compression through writing.  For
1930
               more information on the BZIP2 algorithm, see
1931
               <see href="http://en.wikipedia.org/wiki/BZIP2"/>.
1932
             </para>
1933
            
1934
             <para>
1935
               This class is similar to <see cref="T:Ionic.BZip2.BZip2OutputStream"/>,
1936
               except that this implementation uses an approach that employs multiple
1937
               worker threads to perform the compression.  On a multi-cpu or multi-core
1938
               computer, the performance of this class can be significantly higher than
1939
               the single-threaded BZip2OutputStream, particularly for larger streams.
1940
               How large?  Anything over 10mb is a good candidate for parallel
1941
               compression.
1942
             </para>
1943
            
1944
             <para>
1945
               The tradeoff is that this class uses more memory and more CPU than the
1946
               vanilla <c>BZip2OutputStream</c>. Also, for small files, the
1947
               <c>ParallelBZip2OutputStream</c> can be much slower than the vanilla
1948
               <c>BZip2OutputStream</c>, because of the overhead associated to using the
1949
               thread pool.
1950
             </para>
1951
            
1952
             <seealso cref="T:Ionic.BZip2.BZip2OutputStream" />
1953
        </member>
1954
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream)">
1955
             <summary>
1956
               Constructs a new <c>ParallelBZip2OutputStream</c>, that sends its
1957
               compressed output to the given output stream.
1958
             </summary>
1959
            
1960
             <param name='output'>
1961
               The destination stream, to which compressed output will be sent.
1962
             </param>
1963
            
1964
             <example>
1965
            
1966
               This example reads a file, then compresses it with bzip2 file,
1967
               and writes the compressed data into a newly created file.
1968
            
1969
               <code>
1970
               var fname = "logfile.log";
1971
               using (var fs = File.OpenRead(fname))
1972
               {
1973
                   var outFname = fname + ".bz2";
1974
                   using (var output = File.Create(outFname))
1975
                   {
1976
                       using (var compressor = new Ionic.BZip2.ParallelBZip2OutputStream(output))
1977
                       {
1978
                           byte[] buffer = new byte[2048];
1979
                           int n;
1980
                           while ((n = fs.Read(buffer, 0, buffer.Length)) > 0)
1981
                           {
1982
                               compressor.Write(buffer, 0, n);
1983
                           }
1984
                       }
1985
                   }
1986
               }
1987
               </code>
1988
             </example>
1989
        </member>
1990
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream,System.Int32)">
1991
            <summary>
1992
              Constructs a new <c>ParallelBZip2OutputStream</c> with specified blocksize.
1993
            </summary>
1994
            <param name = "output">the destination stream.</param>
1995
            <param name = "blockSize">
1996
              The blockSize in units of 100000 bytes.
1997
              The valid range is 1..9.
1998
            </param>
1999
        </member>
2000
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream,System.Boolean)">
2001
            <summary>
2002
              Constructs a new <c>ParallelBZip2OutputStream</c>.
2003
            </summary>
2004
              <param name = "output">the destination stream.</param>
2005
            <param name = "leaveOpen">
2006
              whether to leave the captive stream open upon closing this stream.
2007
            </param>
2008
        </member>
2009
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream,System.Int32,System.Boolean)">
2010
             <summary>
2011
               Constructs a new <c>ParallelBZip2OutputStream</c> with specified blocksize,
2012
               and explicitly specifies whether to leave the wrapped stream open.
2013
             </summary>
2014
            
2015
             <param name = "output">the destination stream.</param>
2016
             <param name = "blockSize">
2017
               The blockSize in units of 100000 bytes.
2018
               The valid range is 1..9.
2019
             </param>
2020
             <param name = "leaveOpen">
2021
               whether to leave the captive stream open upon closing this stream.
2022
             </param>
2023
        </member>
2024
        <member name="P:Ionic.BZip2.ParallelBZip2OutputStream.MaxWorkers">
2025
             <summary>
2026
               The maximum number of concurrent compression worker threads to use.
2027
             </summary>
2028
            
2029
             <remarks>
2030
             <para>
2031
               This property sets an upper limit on the number of concurrent worker
2032
               threads to employ for compression. The implementation of this stream
2033
               employs multiple threads from the .NET thread pool, via 
2034
               ThreadPool.QueueUserWorkItem(), to compress the incoming data by
2035
               block.  As each block of data is compressed, this stream re-orders the
2036
               compressed blocks and writes them to the output stream.
2037
             </para>
2038
            
2039
             <para>
2040
               A higher number of workers enables a higher degree of
2041
               parallelism, which tends to increase the speed of compression on
2042
               multi-cpu computers.  On the other hand, a higher number of buffer
2043
               pairs also implies a larger memory consumption, more active worker
2044
               threads, and a higher cpu utilization for any compression. This
2045
               property enables the application to limit its memory consumption and
2046
               CPU utilization behavior depending on requirements.
2047
             </para>
2048
            
2049
             <para>
2050
               By default, DotNetZip allocates 4 workers per CPU core, subject to the
2051
               upper limit specified in this property. For example, suppose the
2052
               application sets this property to 16.  Then, on a machine with 2
2053
               cores, DotNetZip will use 8 workers; that number does not exceed the
2054
               upper limit specified by this property, so the actual number of
2055
               workers used will be 4 * 2 = 8.  On a machine with 4 cores, DotNetZip
2056
               will use 16 workers; again, the limit does not apply. On a machine
2057
               with 8 cores, DotNetZip will use 16 workers, because of the limit.
2058
             </para>
2059
            
2060
             <para>
2061
               For each compression "worker thread" that occurs in parallel, there is
2062
               up to 2mb of memory allocated, for buffering and processing. The
2063
               actual number depends on the <see cref="P:Ionic.BZip2.ParallelBZip2OutputStream.BlockSize"/> property.
2064
             </para>
2065
            
2066
             <para>
2067
               CPU utilization will also go up with additional workers, because a
2068
               larger number of buffer pairs allows a larger number of background
2069
               threads to compress in parallel. If you find that parallel
2070
               compression is consuming too much memory or CPU, you can adjust this
2071
               value downward.
2072
             </para>
2073
            
2074
             <para>
2075
               The default value is 16. Different values may deliver better or
2076
               worse results, depending on your priorities and the dynamic
2077
               performance characteristics of your storage and compute resources.
2078
             </para>
2079
            
2080
             <para>
2081
               The application can set this value at any time, but it is effective
2082
               only before the first call to Write(), which is when the buffers are
2083
               allocated.
2084
             </para>
2085
             </remarks>
2086
        </member>
2087
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Flush">
2088
            <summary>
2089
              Flush the stream.
2090
            </summary>
2091
        </member>
2092
        <member name="P:Ionic.BZip2.ParallelBZip2OutputStream.BlockSize">
2093
            <summary>
2094
              The blocksize parameter specified at construction time.
2095
            </summary>
2096
        </member>
2097
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Write(System.Byte[],System.Int32,System.Int32)">
2098
             <summary>
2099
               Write data to the stream.
2100
             </summary>
2101
             <remarks>
2102
            
2103
             <para>
2104
               Use the <c>ParallelBZip2OutputStream</c> to compress data while
2105
               writing: create a <c>ParallelBZip2OutputStream</c> with a writable
2106
               output stream.  Then call <c>Write()</c> on that
2107
               <c>ParallelBZip2OutputStream</c>, providing uncompressed data as
2108
               input.  The data sent to the output stream will be the compressed
2109
               form of the input data.
2110
             </para>
2111
            
2112
             <para>
2113
               A <c>ParallelBZip2OutputStream</c> can be used only for
2114
               <c>Write()</c> not for <c>Read()</c>.
2115
             </para>
2116
            
2117
             </remarks>
2118
            
2119
             <param name="buffer">The buffer holding data to write to the stream.</param>
2120
             <param name="offset">the offset within that data array to find the first byte to write.</param>
2121
             <param name="count">the number of bytes to write.</param>
2122
        </member>
2123
        <member name="P:Ionic.BZip2.ParallelBZip2OutputStream.CanRead">
2124
            <summary>
2125
            Indicates whether the stream can be read.
2126
            </summary>
2127
            <remarks>
2128
            The return value is always false.
2129
            </remarks>
2130
        </member>
2131
        <member name="P:Ionic.BZip2.ParallelBZip2OutputStream.CanSeek">
2132
            <summary>
2133
            Indicates whether the stream supports Seek operations.
2134
            </summary>
2135
            <remarks>
2136
            Always returns false.
2137
            </remarks>
2138
        </member>
2139
        <member name="P:Ionic.BZip2.ParallelBZip2OutputStream.CanWrite">
2140
            <summary>
2141
            Indicates whether the stream can be written.
2142
            </summary>
2143
            <remarks>
2144
            The return value depends on whether the captive stream supports writing.
2145
            </remarks>
2146
        </member>
2147
        <member name="P:Ionic.BZip2.ParallelBZip2OutputStream.Length">
2148
            <summary>
2149
            Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
2150
            </summary>
2151
        </member>
2152
        <member name="P:Ionic.BZip2.ParallelBZip2OutputStream.Position">
2153
             <summary>
2154
             The position of the stream pointer.
2155
             </summary>
2156
            
2157
             <remarks>
2158
               Setting this property always throws a <see
2159
               cref="T:System.NotImplementedException"/>. Reading will return the
2160
               total number of uncompressed bytes written through.
2161
             </remarks>
2162
        </member>
2163
        <member name="P:Ionic.BZip2.ParallelBZip2OutputStream.BytesWrittenOut">
2164
            <summary>
2165
            The total number of bytes written out by the stream.
2166
            </summary>
2167
            <remarks>
2168
            This value is meaningful only after a call to Close().
2169
            </remarks>
2170
        </member>
2171
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
2172
            <summary>
2173
            Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
2174
            </summary>
2175
            <param name="offset">this is irrelevant, since it will always throw!</param>
2176
            <param name="origin">this is irrelevant, since it will always throw!</param>
2177
            <returns>irrelevant!</returns>
2178
        </member>
2179
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.SetLength(System.Int64)">
2180
            <summary>
2181
            Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
2182
            </summary>
2183
            <param name="value">this is irrelevant, since it will always throw!</param>
2184
        </member>
2185
        <member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Read(System.Byte[],System.Int32,System.Int32)">
2186
            <summary>
2187
            Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
2188
            </summary>
2189
            <param name='buffer'>this parameter is never used</param>
2190
            <param name='offset'>this parameter is never used</param>
2191
            <param name='count'>this parameter is never used</param>
2192
            <returns>never returns anything; always throws</returns>
2193
        </member>
2194
        <member name="M:Ionic.BZip2.Rand.Rnums(System.Int32)">
2195
            <summary>
2196
              Returns the "random" number at a specific index.
2197
            </summary>
2198
            <param name='i'>the index</param>
2199
            <returns>the random number</returns>
2200
        </member>
2201
        <member name="T:Ionic.Crc.CRC32">
2202
            <summary>
2203
              Computes a CRC-32. The CRC-32 algorithm is parameterized - you
2204
              can set the polynomial and enable or disable bit
2205
              reversal. This can be used for GZIP, BZip2, or ZIP.
2206
            </summary>
2207
            <remarks>
2208
              This type is used internally by DotNetZip; it is generally not used
2209
              directly by applications wishing to create, read, or manipulate zip
2210
              archive files.
2211
            </remarks>
2212
        </member>
2213
        <member name="P:Ionic.Crc.CRC32.TotalBytesRead">
2214
            <summary>
2215
              Indicates the total number of bytes applied to the CRC.
2216
            </summary>
2217
        </member>
2218
        <member name="P:Ionic.Crc.CRC32.Crc32Result">
2219
            <summary>
2220
            Indicates the current CRC for all blocks slurped in.
2221
            </summary>
2222
        </member>
2223
        <member name="M:Ionic.Crc.CRC32.GetCrc32(System.IO.Stream)">
2224
            <summary>
2225
            Returns the CRC32 for the specified stream.
2226
            </summary>
2227
            <param name="input">The stream over which to calculate the CRC32</param>
2228
            <returns>the CRC32 calculation</returns>
2229
        </member>
2230
        <member name="M:Ionic.Crc.CRC32.GetCrc32AndCopy(System.IO.Stream,System.IO.Stream)">
2231
            <summary>
2232
            Returns the CRC32 for the specified stream, and writes the input into the
2233
            output stream.
2234
            </summary>
2235
            <param name="input">The stream over which to calculate the CRC32</param>
2236
            <param name="output">The stream into which to deflate the input</param>
2237
            <returns>the CRC32 calculation</returns>
2238
        </member>
2239
        <member name="M:Ionic.Crc.CRC32.ComputeCrc32(System.Int32,System.Byte)">
2240
            <summary>
2241
              Get the CRC32 for the given (word,byte) combo.  This is a
2242
              computation defined by PKzip for PKZIP 2.0 (weak) encryption.
2243
            </summary>
2244
            <param name="W">The word to start with.</param>
2245
            <param name="B">The byte to combine it with.</param>
2246
            <returns>The CRC-ized result.</returns>
2247
        </member>
2248
        <member name="M:Ionic.Crc.CRC32.SlurpBlock(System.Byte[],System.Int32,System.Int32)">
2249
            <summary>
2250
            Update the value for the running CRC32 using the given block of bytes.
2251
            This is useful when using the CRC32() class in a Stream.
2252
            </summary>
2253
            <param name="block">block of bytes to slurp</param>
2254
            <param name="offset">starting point in the block</param>
2255
            <param name="count">how many bytes within the block to slurp</param>
2256
        </member>
2257
        <member name="M:Ionic.Crc.CRC32.UpdateCRC(System.Byte)">
2258
            <summary>
2259
              Process one byte in the CRC.
2260
            </summary>
2261
            <param name = "b">the byte to include into the CRC .  </param>
2262
        </member>
2263
        <member name="M:Ionic.Crc.CRC32.UpdateCRC(System.Byte,System.Int32)">
2264
            <summary>
2265
              Process a run of N identical bytes into the CRC.
2266
            </summary>
2267
            <remarks>
2268
              <para>
2269
                This method serves as an optimization for updating the CRC when a
2270
                run of identical bytes is found. Rather than passing in a buffer of
2271
                length n, containing all identical bytes b, this method accepts the
2272
                byte value and the length of the (virtual) buffer - the length of
2273
                the run.
2274
              </para>
2275
            </remarks>
2276
            <param name = "b">the byte to include into the CRC.  </param>
2277
            <param name = "n">the number of times that byte should be repeated. </param>
2278
        </member>
2279
        <member name="M:Ionic.Crc.CRC32.Combine(System.Int32,System.Int32)">
2280
            <summary>
2281
              Combines the given CRC32 value with the current running total.
2282
            </summary>
2283
            <remarks>
2284
              This is useful when using a divide-and-conquer approach to
2285
              calculating a CRC.  Multiple threads can each calculate a
2286
              CRC32 on a segment of the data, and then combine the
2287
              individual CRC32 values at the end.
2288
            </remarks>
2289
            <param name="crc">the crc value to be combined with this one</param>
2290
            <param name="length">the length of data the CRC value was calculated on</param>
2291
        </member>
2292
        <member name="M:Ionic.Crc.CRC32.#ctor">
2293
            <summary>
2294
              Create an instance of the CRC32 class using the default settings: no
2295
              bit reversal, and a polynomial of 0xEDB88320.
2296
            </summary>
2297
        </member>
2298
        <member name="M:Ionic.Crc.CRC32.#ctor(System.Boolean)">
2299
            <summary>
2300
              Create an instance of the CRC32 class, specifying whether to reverse
2301
              data bits or not.
2302
            </summary>
2303
            <param name='reverseBits'>
2304
              specify true if the instance should reverse data bits.
2305
            </param>
2306
            <remarks>
2307
              <para>
2308
                In the CRC-32 used by BZip2, the bits are reversed. Therefore if you
2309
                want a CRC32 with compatibility with BZip2, you should pass true
2310
                here. In the CRC-32 used by GZIP and PKZIP, the bits are not
2311
                reversed; Therefore if you want a CRC32 with compatibility with
2312
                those, you should pass false.
2313
              </para>
2314
            </remarks>
2315
        </member>
2316
        <member name="M:Ionic.Crc.CRC32.#ctor(System.Int32,System.Boolean)">
2317
             <summary>
2318
               Create an instance of the CRC32 class, specifying the polynomial and
2319
               whether to reverse data bits or not.
2320
             </summary>
2321
             <param name='polynomial'>
2322
               The polynomial to use for the CRC, expressed in the reversed (LSB)
2323
               format: the highest ordered bit in the polynomial value is the
2324
               coefficient of the 0th power; the second-highest order bit is the
2325
               coefficient of the 1 power, and so on. Expressed this way, the
2326
               polynomial for the CRC-32C used in IEEE 802.3, is 0xEDB88320.
2327
             </param>
2328
             <param name='reverseBits'>
2329
               specify true if the instance should reverse data bits.
2330
             </param>
2331
            
2332
             <remarks>
2333
               <para>
2334
                 In the CRC-32 used by BZip2, the bits are reversed. Therefore if you
2335
                 want a CRC32 with compatibility with BZip2, you should pass true
2336
                 here for the <c>reverseBits</c> parameter. In the CRC-32 used by
2337
                 GZIP and PKZIP, the bits are not reversed; Therefore if you want a
2338
                 CRC32 with compatibility with those, you should pass false for the
2339
                 <c>reverseBits</c> parameter.
2340
               </para>
2341
             </remarks>
2342
        </member>
2343
        <member name="M:Ionic.Crc.CRC32.Reset">
2344
            <summary>
2345
              Reset the CRC-32 class - clear the CRC "remainder register."
2346
            </summary>
2347
            <remarks>
2348
              <para>
2349
                Use this when employing a single instance of this class to compute
2350
                multiple, distinct CRCs on multiple, distinct data blocks.
2351
              </para>
2352
            </remarks>
2353
        </member>
2354
        <member name="T:Ionic.Crc.CrcCalculatorStream">
2355
             <summary>
2356
             A Stream that calculates a CRC32 (a checksum) on all bytes read,
2357
             or on all bytes written.
2358
             </summary>
2359
            
2360
             <remarks>
2361
             <para>
2362
             This class can be used to verify the CRC of a ZipEntry when
2363
             reading from a stream, or to calculate a CRC when writing to a
2364
             stream.  The stream should be used to either read, or write, but
2365
             not both.  If you intermix reads and writes, the results are not
2366
             defined.
2367
             </para>
2368
            
2369
             <para>
2370
             This class is intended primarily for use internally by the
2371
             DotNetZip library.
2372
             </para>
2373
             </remarks>
2374
        </member>
2375
        <member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream)">
2376
            <summary>
2377
            The default constructor.
2378
            </summary>
2379
            <remarks>
2380
              <para>
2381
                Instances returned from this constructor will leave the underlying
2382
                stream open upon Close().  The stream uses the default CRC32
2383
                algorithm, which implies a polynomial of 0xEDB88320.
2384
              </para>
2385
            </remarks>
2386
            <param name="stream">The underlying stream</param>
2387
        </member>
2388
        <member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Boolean)">
2389
            <summary>
2390
              The constructor allows the caller to specify how to handle the
2391
              underlying stream at close.
2392
            </summary>
2393
            <remarks>
2394
              <para>
2395
                The stream uses the default CRC32 algorithm, which implies a
2396
                polynomial of 0xEDB88320.
2397
              </para>
2398
            </remarks>
2399
            <param name="stream">The underlying stream</param>
2400
            <param name="leaveOpen">true to leave the underlying stream
2401
            open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
2402
        </member>
2403
        <member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64)">
2404
            <summary>
2405
              A constructor allowing the specification of the length of the stream
2406
              to read.
2407
            </summary>
2408
            <remarks>
2409
              <para>
2410
                The stream uses the default CRC32 algorithm, which implies a
2411
                polynomial of 0xEDB88320.
2412
              </para>
2413
              <para>
2414
                Instances returned from this constructor will leave the underlying
2415
                stream open upon Close().
2416
              </para>
2417
            </remarks>
2418
            <param name="stream">The underlying stream</param>
2419
            <param name="length">The length of the stream to slurp</param>
2420
        </member>
2421
        <member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64,System.Boolean)">
2422
            <summary>
2423
              A constructor allowing the specification of the length of the stream
2424
              to read, as well as whether to keep the underlying stream open upon
2425
              Close().
2426
            </summary>
2427
            <remarks>
2428
              <para>
2429
                The stream uses the default CRC32 algorithm, which implies a
2430
                polynomial of 0xEDB88320.
2431
              </para>
2432
            </remarks>
2433
            <param name="stream">The underlying stream</param>
2434
            <param name="length">The length of the stream to slurp</param>
2435
            <param name="leaveOpen">true to leave the underlying stream
2436
            open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
2437
        </member>
2438
        <member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64,System.Boolean,Ionic.Crc.CRC32)">
2439
            <summary>
2440
              A constructor allowing the specification of the length of the stream
2441
              to read, as well as whether to keep the underlying stream open upon
2442
              Close(), and the CRC32 instance to use.
2443
            </summary>
2444
            <remarks>
2445
              <para>
2446
                The stream uses the specified CRC32 instance, which allows the
2447
                application to specify how the CRC gets calculated.
2448
              </para>
2449
            </remarks>
2450
            <param name="stream">The underlying stream</param>
2451
            <param name="length">The length of the stream to slurp</param>
2452
            <param name="leaveOpen">true to leave the underlying stream
2453
            open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
2454
            <param name="crc32">the CRC32 instance to use to calculate the CRC32</param>
2455
        </member>
2456
        <member name="P:Ionic.Crc.CrcCalculatorStream.TotalBytesSlurped">
2457
             <summary>
2458
               Gets the total number of bytes run through the CRC32 calculator.
2459
             </summary>
2460
            
2461
             <remarks>
2462
               This is either the total number of bytes read, or the total number of
2463
               bytes written, depending on the direction of this stream.
2464
             </remarks>
2465
        </member>
2466
        <member name="P:Ionic.Crc.CrcCalculatorStream.Crc">
2467
            <summary>
2468
              Provides the current CRC for all blocks slurped in.
2469
            </summary>
2470
            <remarks>
2471
              <para>
2472
                The running total of the CRC is kept as data is written or read
2473
                through the stream.  read this property after all reads or writes to
2474
                get an accurate CRC for the entire stream.
2475
              </para>
2476
            </remarks>
2477
        </member>
2478
        <member name="P:Ionic.Crc.CrcCalculatorStream.LeaveOpen">
2479
            <summary>
2480
              Indicates whether the underlying stream will be left open when the
2481
              <c>CrcCalculatorStream</c> is Closed.
2482
            </summary>
2483
            <remarks>
2484
              <para>
2485
                Set this at any point before calling <see cref="!:Close()"/>.
2486
              </para>
2487
            </remarks>
2488
        </member>
2489
        <member name="M:Ionic.Crc.CrcCalculatorStream.Read(System.Byte[],System.Int32,System.Int32)">
2490
            <summary>
2491
            Read from the stream
2492
            </summary>
2493
            <param name="buffer">the buffer to read</param>
2494
            <param name="offset">the offset at which to start</param>
2495
            <param name="count">the number of bytes to read</param>
2496
            <returns>the number of bytes actually read</returns>
2497
        </member>
2498
        <member name="M:Ionic.Crc.CrcCalculatorStream.Write(System.Byte[],System.Int32,System.Int32)">
2499
            <summary>
2500
            Write to the stream.
2501
            </summary>
2502
            <param name="buffer">the buffer from which to write</param>
2503
            <param name="offset">the offset at which to start writing</param>
2504
            <param name="count">the number of bytes to write</param>
2505
        </member>
2506
        <member name="P:Ionic.Crc.CrcCalculatorStream.CanRead">
2507
            <summary>
2508
            Indicates whether the stream supports reading.
2509
            </summary>
2510
        </member>
2511
        <member name="P:Ionic.Crc.CrcCalculatorStream.CanSeek">
2512
            <summary>
2513
              Indicates whether the stream supports seeking.
2514
            </summary>
2515
            <remarks>
2516
              <para>
2517
                Always returns false.
2518
              </para>
2519
            </remarks>
2520
        </member>
2521
        <member name="P:Ionic.Crc.CrcCalculatorStream.CanWrite">
2522
            <summary>
2523
            Indicates whether the stream supports writing.
2524
            </summary>
2525
        </member>
2526
        <member name="M:Ionic.Crc.CrcCalculatorStream.Flush">
2527
            <summary>
2528
            Flush the stream.
2529
            </summary>
2530
        </member>
2531
        <member name="P:Ionic.Crc.CrcCalculatorStream.Length">
2532
            <summary>
2533
              Returns the length of the underlying stream.
2534
            </summary>
2535
        </member>
2536
        <member name="P:Ionic.Crc.CrcCalculatorStream.Position">
2537
            <summary>
2538
              The getter for this property returns the total bytes read.
2539
              If you use the setter, it will throw
2540
            <see cref="T:System.NotSupportedException"/>.
2541
            </summary>
2542
        </member>
2543
        <member name="M:Ionic.Crc.CrcCalculatorStream.Seek(System.Int64,System.IO.SeekOrigin)">
2544
            <summary>
2545
            Seeking is not supported on this stream. This method always throws
2546
            <see cref="T:System.NotSupportedException"/>
2547
            </summary>
2548
            <param name="offset">N/A</param>
2549
            <param name="origin">N/A</param>
2550
            <returns>N/A</returns>
2551
        </member>
2552
        <member name="M:Ionic.Crc.CrcCalculatorStream.SetLength(System.Int64)">
2553
            <summary>
2554
            This method always throws
2555
            <see cref="T:System.NotSupportedException"/>
2556
            </summary>
2557
            <param name="value">N/A</param>
2558
        </member>
2559
        <member name="T:ComponentAce.Compression.Libs.ZLib.Adler32">
2560
            <summary>
2561
            This class represents adler32 checksum algorithm
2562
            </summary>
2563
        </member>
2564
        <member name="M:ComponentAce.Compression.Libs.ZLib.Adler32.GetAdler32Checksum(System.Int64,System.Byte[],System.Int32,System.Int32)">
2565
            <summary>
2566
            This static method returns adler32 checksum of the buffer data
2567
            </summary>
2568
        </member>
2569
        <member name="T:ComponentAce.Compression.Libs.ZLib.Deflate">
2570
            <summary>
2571
            Implementation of the Deflate compression algorithm.
2572
            </summary>
2573
        </member>
2574
        <member name="T:ComponentAce.Compression.Libs.ZLib.Deflate.Config">
2575
            <summary>
2576
            Deflate algorithm configuration parameters class
2577
            </summary>
2578
        </member>
2579
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.Config.good_length">
2580
            <summary>
2581
            reduce lazy search above this match length
2582
            </summary>
2583
        </member>
2584
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.Config.max_lazy">
2585
            <summary>
2586
            do not perform lazy search above this match length
2587
            </summary>
2588
        </member>
2589
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.Config.nice_length">
2590
            <summary>
2591
            quit search above this match length
2592
            </summary>
2593
        </member>
2594
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.Config.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
2595
            <summary>
2596
            Constructor which initializes class inner fields
2597
            </summary>
2598
        </member>
2599
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.MAX_MEM_LEVEL">
2600
            <summary>
2601
            Maximum memory level
2602
            </summary>
2603
        </member>
2604
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.Z_DEFAULT_COMPRESSION">
2605
            <summary>
2606
            Defalult compression method
2607
            </summary>
2608
        </member>
2609
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.DEF_MEM_LEVEL">
2610
            <summary>
2611
            Default memory level
2612
            </summary>
2613
        </member>
2614
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.config_table">
2615
            <summary>
2616
            Deflate class congiration table
2617
            </summary>
2618
        </member>
2619
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.NeedMore">
2620
            <summary>
2621
            block not completed, need more input or more output
2622
            </summary>
2623
        </member>
2624
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.BlockDone">
2625
            <summary>
2626
            Block internalFlush performed
2627
            </summary>
2628
        </member>
2629
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.FinishStarted">
2630
            <summary>
2631
            Finish started, need only more output at next deflate
2632
            </summary>
2633
        </member>
2634
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.FinishDone">
2635
            <summary>
2636
            finish done, accept no more input or output
2637
            </summary>
2638
        </member>
2639
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.PRESET_DICT">
2640
            <summary>
2641
            preset dictionary flag in zlib header
2642
            </summary>
2643
        </member>
2644
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.Z_DEFLATED">
2645
            <summary>
2646
            The deflate compression method
2647
            </summary>
2648
        </member>
2649
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.Buf_size">
2650
            <summary>
2651
            The size of the buffer
2652
            </summary>
2653
        </member>
2654
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.REP_3_6">
2655
            <summary>
2656
            repeat previous bit length 3-6 times (2 bits of repeat count)
2657
            </summary>
2658
        </member>
2659
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.REPZ_3_10">
2660
            <summary>
2661
            repeat a zero length 3-10 times  (3 bits of repeat count)
2662
            </summary>
2663
        </member>
2664
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.REPZ_11_138">
2665
            <summary>
2666
            repeat a zero length 11-138 times  (7 bits of repeat count)
2667
            </summary>
2668
        </member>
2669
        <member name="P:ComponentAce.Compression.Libs.ZLib.Deflate.level">
2670
            <summary>
2671
            Compression level
2672
            </summary>
2673
        </member>
2674
        <member name="P:ComponentAce.Compression.Libs.ZLib.Deflate.Pending">
2675
            <summary>
2676
            Number of bytes in the pending buffer
2677
            </summary>
2678
        </member>
2679
        <member name="P:ComponentAce.Compression.Libs.ZLib.Deflate.Pending_buf">
2680
            <summary>
2681
            Output still pending
2682
            </summary>
2683
        </member>
2684
        <member name="P:ComponentAce.Compression.Libs.ZLib.Deflate.Pending_out">
2685
            <summary>
2686
            Next pending byte to output to the stream
2687
            </summary>
2688
        </member>
2689
        <member name="P:ComponentAce.Compression.Libs.ZLib.Deflate.NoHeader">
2690
            <summary>
2691
            suppress zlib header and adler32
2692
            </summary>
2693
        </member>
2694
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.strm">
2695
            <summary>
2696
            Pointer back to this zlib stream
2697
            </summary>
2698
        </member>
2699
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.status">
2700
            <summary>
2701
            As the name implies
2702
            </summary>
2703
        </member>
2704
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.pending_buf">
2705
            <summary>
2706
            Output still pending
2707
            </summary>
2708
        </member>
2709
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.pending_buf_size">
2710
            <summary>
2711
            Size of Pending_buf
2712
            </summary>
2713
        </member>
2714
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.pending_out">
2715
            <summary>
2716
            Next pending byte to output to the stream
2717
            </summary>
2718
        </member>
2719
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.pending">
2720
            <summary>
2721
            Number of bytes in the pending buffer
2722
            </summary>
2723
        </member>
2724
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.noheader">
2725
            <summary>
2726
            suppress zlib header and adler32
2727
            </summary>
2728
        </member>
2729
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.data_type">
2730
            <summary>
2731
            UNKNOWN, BINARY or ASCII
2732
            </summary>
2733
        </member>
2734
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.method">
2735
            <summary>
2736
            STORED (for zip only) or DEFLATED
2737
            </summary>
2738
        </member>
2739
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.last_flush">
2740
            <summary>
2741
            Value of internalFlush parameter for previous deflate call
2742
            </summary>
2743
        </member>
2744
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.w_size">
2745
            <summary>
2746
            LZ77 Window size (32K by default)
2747
            </summary>
2748
        </member>
2749
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.w_bits">
2750
            <summary>
2751
            log2(w_size)  (8..16)
2752
            </summary>
2753
        </member>
2754
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.w_mask">
2755
            <summary>
2756
            w_size - 1
2757
            </summary>
2758
        </member>
2759
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.window">
2760
            <summary>
2761
            Sliding Window. Input bytes are ReadPos into the second half of the Window,
2762
            and move to the first half later to keep a dictionary of at least wSize
2763
            bytes. With this organization, matches are limited to a distance of
2764
            wSize-MAX_MATCH bytes, but this ensures that IO is always
2765
            performed with a length multiple of the block size. Also, it limits
2766
            the Window size to 64K, which is quite useful on MSDOS.
2767
            To do: use the user input buffer as sliding Window.
2768
            </summary>
2769
        </member>
2770
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.window_size">
2771
            <summary>
2772
            Actual size of Window: 2*wSize, except when the user input buffer is directly used as sliding Window.
2773
            </summary>
2774
        </member>
2775
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.prev">
2776
            <summary>
2777
            Link to older string with same hash index. To limit the size of this
2778
            array to 64K, this link is maintained only for the last 32K strings.
2779
            An index in this array is thus a Window index modulo 32K.
2780
            </summary>
2781
        </member>
2782
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.head">
2783
            <summary>
2784
            Heads of the hash chains or NIL.
2785
            </summary>
2786
        </member>
2787
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.ins_h">
2788
            <summary>
2789
            hash index of string to be inserted
2790
            </summary>
2791
        </member>
2792
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.hash_size">
2793
            <summary>
2794
            number of elements in hash table
2795
            </summary>
2796
        </member>
2797
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.hash_bits">
2798
            <summary>
2799
            log2(hash_size)
2800
            </summary>
2801
        </member>
2802
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.hash_mask">
2803
            <summary>
2804
            hash_size-1
2805
            </summary>
2806
        </member>
2807
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.hash_shift">
2808
            <summary>
2809
            Number of bits by which ins_h must be shifted at each input
2810
            step. It must be such that after MIN_MATCH steps, the oldest
2811
            byte no longer takes part in the hash key, that is:
2812
            hash_shift * MIN_MATCH >= hash_bits
2813
            </summary>
2814
        </member>
2815
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.block_start">
2816
            <summary>
2817
            Window position at the beginning of the current output block. Gets negative when the Window is moved backwards.
2818
            </summary>
2819
        </member>
2820
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.match_length">
2821
            <summary>
2822
            length of best match
2823
            </summary>
2824
        </member>
2825
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.prev_match">
2826
            <summary>
2827
            previous match
2828
            </summary>
2829
        </member>
2830
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.match_available">
2831
            <summary>
2832
            set if previous match exists
2833
            </summary>
2834
        </member>
2835
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.strstart">
2836
            <summary>
2837
            start of string to insert
2838
            </summary>
2839
        </member>
2840
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.match_start">
2841
            <summary>
2842
            start of matching string
2843
            </summary>
2844
        </member>
2845
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.lookahead">
2846
            <summary>
2847
            number of valid bytes ahead in Window
2848
            </summary>
2849
        </member>
2850
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.prev_length">
2851
            <summary>
2852
            Length of the best match at previous step. Matches not greater than this
2853
            are discarded. This is used in the lazy match evaluation.
2854
            </summary>
2855
        </member>
2856
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.max_chain_length">
2857
            <summary>
2858
            To speed up deflation, hash chains are never searched beyond this
2859
            length.  A higher limit improves compression ratio but degrades the speed.
2860
            </summary>
2861
        </member>
2862
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.max_lazy_match">
2863
            <summary>
2864
            Attempt to find a better match only when the current match is strictly
2865
            smaller than this value. This mechanism is used only for compression
2866
            levels >= 4.
2867
            </summary>
2868
        </member>
2869
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate._level">
2870
            <summary>
2871
            compression level (1..9)
2872
            </summary>
2873
        </member>
2874
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.strategy">
2875
            <summary>
2876
            favor or force Huffman coding
2877
            </summary>
2878
        </member>
2879
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.good_match">
2880
            <summary>
2881
            Use a faster search when the previous match is longer than this
2882
            </summary>
2883
        </member>
2884
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.nice_match">
2885
            <summary>
2886
            Stop searching when current match exceeds this
2887
            </summary>
2888
        </member>
2889
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.dyn_ltree">
2890
            <summary>
2891
            literal and length tree
2892
            </summary>
2893
        </member>
2894
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.dyn_dtree">
2895
            <summary>
2896
            distance tree
2897
            </summary>
2898
        </member>
2899
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.bl_tree">
2900
            <summary>
2901
             Huffman tree for bit lengths
2902
            </summary>
2903
        </member>
2904
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.l_desc">
2905
            <summary>
2906
            Desc for literal tree
2907
            </summary>
2908
        </member>
2909
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.d_desc">
2910
            <summary>
2911
            desc for distance tree
2912
            </summary>
2913
        </member>
2914
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.bl_desc">
2915
            <summary>
2916
            desc for bit length tree
2917
            </summary>
2918
        </member>
2919
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.bl_count">
2920
            <summary>
2921
            number of codes at each bit length for an optimal tree
2922
            </summary>
2923
        </member>
2924
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.heap">
2925
            <summary>
2926
            heap used to build the Huffman trees
2927
            </summary>
2928
        </member>
2929
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.heap_len">
2930
            <summary>
2931
            number of elements in the heap
2932
            </summary>
2933
        </member>
2934
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.heap_max">
2935
            <summary>
2936
            element of largest frequency
2937
            </summary>
2938
        </member>
2939
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.depth">
2940
            <summary>
2941
            Depth of each subtree used as tie breaker for trees of equal frequency
2942
            </summary>
2943
        </member>
2944
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.l_buf">
2945
            <summary>
2946
            index for literals or lengths
2947
            </summary>
2948
        </member>
2949
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.lit_bufsize">
2950
            <summary>
2951
             Size of match buffer for literals/lengths.  There are 4 reasons for
2952
             limiting lit_bufsize to 64K:
2953
               - frequencies can be kept in 16 bit counters
2954
               - if compression is not successful for the first block, all input
2955
                 data is still in the Window so we can still emit a stored block even
2956
                 when input comes from standard input.  (This can also be done for
2957
                 all blocks if lit_bufsize is not greater than 32K.)
2958
               - if compression is not successful for a file smaller than 64K, we can
2959
                 even emit a stored file instead of a stored block (saving 5 bytes).
2960
                 This is applicable only for zip (not gzip or zlib).
2961
               - creating new Huffman trees less frequently may not provide fast
2962
                 adaptation to changes in the input data statistics. (Take for
2963
                 example a binary file with poorly compressible code followed by
2964
                 a highly compressible string table.) Smaller buffer sizes give
2965
                 fast adaptation but have of course the overhead of transmitting
2966
                 trees more frequently.
2967
               - I can't count above 4
2968
            </summary> 
2969
        </member>
2970
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.last_lit">
2971
            <summary>
2972
            running index in l_buf
2973
            </summary>
2974
        </member>
2975
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.d_buf">
2976
            <summary>
2977
            index of pendig_buf
2978
            </summary>
2979
        </member>
2980
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.opt_len">
2981
            <summary>
2982
            bit length of current block with optimal trees
2983
            </summary>
2984
        </member>
2985
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.static_len">
2986
            <summary>
2987
            bit length of current block with static trees
2988
            </summary>
2989
        </member>
2990
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.matches">
2991
            <summary>
2992
            number of string matches in current block
2993
            </summary>
2994
        </member>
2995
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.last_eob_len">
2996
            <summary>
2997
            bit length of EOB code for last block
2998
            </summary>
2999
        </member>
3000
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.bi_buf">
3001
            <summary>
3002
            Output buffer. bits are inserted starting at the bottom (least
3003
            significant bits).
3004
            </summary>
3005
        </member>
3006
        <member name="F:ComponentAce.Compression.Libs.ZLib.Deflate.bi_valid">
3007
            <summary>
3008
            Number of valid bits in bi_buf.  All bits above the last valid bit
3009
            are always zero.
3010
            </summary>
3011
        </member>
3012
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.#ctor">
3013
            <summary>
3014
            Default constructor
3015
            </summary>
3016
        </member>
3017
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.lm_init">
3018
            <summary>
3019
            Initialization
3020
            </summary>
3021
        </member>
3022
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.tr_init">
3023
            <summary>
3024
            Initialize the tree data structures for a new zlib stream.
3025
            </summary>
3026
        </member>
3027
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.init_block">
3028
            <summary>
3029
            Initializes block
3030
            </summary>
3031
        </member>
3032
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.pqdownheap(System.Int16[],System.Int32)">
3033
            <summary>
3034
             Restore the heap property by moving down the tree starting at node k,
3035
             exchanging a node with the smallest of its two sons if necessary, stopping
3036
             when the heap property is re-established (each father smaller than its
3037
             two sons).
3038
             </summary>
3039
        </member>
3040
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.scan_tree(System.Int16[],System.Int32)">
3041
            <summary>
3042
             Scan a literal or distance tree to determine the frequencies of the codes
3043
             in the bit length tree.
3044
             </summary>
3045
        </member>
3046
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.build_bl_tree">
3047
            <summary>
3048
             Construct the Huffman tree for the bit lengths and return the index in
3049
             bl_order of the last bit length code to send.
3050
             </summary>
3051
        </member>
3052
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.send_all_trees(System.Int32,System.Int32,System.Int32)">
3053
            <summary>
3054
             Send the header for a block using dynamic Huffman trees: the counts, the
3055
             lengths of the bit length codes, the literal tree and the distance tree.
3056
             IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
3057
             </summary>
3058
        </member>
3059
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.send_tree(System.Int16[],System.Int32)">
3060
            <summary>
3061
             Send a literal or distance tree in compressed form, using the codes in
3062
             bl_tree.
3063
             </summary>
3064
        </member>
3065
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.put_byte(System.Byte[],System.Int32,System.Int32)">
3066
            <summary>
3067
             Output a byte on the stream.
3068
             IN assertion: there is enough room in Pending_buf.
3069
             </summary>
3070
        </member>
3071
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.put_byte(System.Byte)">
3072
            <summary>
3073
            Adds a byte to the buffer
3074
            </summary>
3075
        </member>
3076
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate._tr_align">
3077
            <summary>
3078
             Send one empty static block to give enough lookahead for inflate.
3079
             This takes 10 bits, of which 7 may remain in the bit buffer.
3080
             The current inflate code requires 9 bits of lookahead. If the
3081
             last two codes for the previous block (real code plus EOB) were coded
3082
             on 5 bits or less, inflate may have only 5+3 bits of lookahead to decode
3083
             the last real code. In this case we send two empty static blocks instead
3084
             of one. (There are no problems if the previous block is stored or fixed.)
3085
             To simplify the code, we assume the worst case of last real code encoded
3086
             on one bit only.
3087
             </summary>
3088
        </member>
3089
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate._tr_tally(System.Int32,System.Int32)">
3090
            <summary>
3091
            Save the match info and tally the frequency counts. Return true if
3092
            the current block must be flushed.
3093
            </summary>
3094
        </member>
3095
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.compress_block(System.Int16[],System.Int16[])">
3096
            <summary>
3097
             Send the block data compressed using the given Huffman trees
3098
            </summary>
3099
        </member>
3100
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.set_data_type">
3101
            <summary>
3102
            Set the data type to ASCII or BINARY, using a crude approximation:
3103
            binary if more than 20% of the bytes are &lt;= 6 or &gt;= 128, ascii otherwise.
3104
            IN assertion: the fields freq of dyn_ltree are set and the total of all
3105
            frequencies does not exceed 64K (to fit in an int on 16 bit machines).
3106
            </summary>
3107
        </member>
3108
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.bi_flush">
3109
            <summary>
3110
            Flush the bit buffer, keeping at most 7 bits in it.
3111
            </summary>
3112
        </member>
3113
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.bi_windup">
3114
            <summary>
3115
            Flush the bit buffer and align the output on a byte boundary
3116
            </summary>
3117
        </member>
3118
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.copy_block(System.Int32,System.Int32,System.Boolean)">
3119
            <summary>
3120
            Copy a stored block, storing first the length and its
3121
            one's complement if requested.
3122
            </summary>
3123
        </member>
3124
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.flush_block_only(System.Boolean)">
3125
            <summary>
3126
            Flushes block
3127
            </summary>
3128
        </member>
3129
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflate_stored(System.Int32)">
3130
            <summary>
3131
            Copy without compression as much as possible from the input stream, return
3132
            the current block state.
3133
            This function does not insert new strings in the dictionary since
3134
            uncompressible data is probably not useful. This function is used
3135
            only for the level=0 compression option.
3136
            NOTE: this function should be optimized to avoid extra copying from
3137
            Window to Pending_buf.
3138
            </summary>
3139
        </member>
3140
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate._tr_stored_block(System.Int32,System.Int32,System.Boolean)">
3141
            <summary>
3142
            Send a stored block
3143
            </summary>
3144
        </member>
3145
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate._tr_flush_block(System.Int32,System.Int32,System.Boolean)">
3146
            <summary>
3147
            Determine the best encoding for the current block: dynamic trees, static
3148
            trees or store, and output the encoded block to the zip file.
3149
            </summary>
3150
        </member>
3151
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.fill_window">
3152
            <summary>
3153
             Fill the Window when the lookahead becomes insufficient.
3154
             Updates strstart and lookahead.
3155
            
3156
             IN assertion: lookahead less than MIN_LOOKAHEAD
3157
             OUT assertions: strstart less than or equal to window_size-MIN_LOOKAHEAD
3158
                At least one byte has been ReadPos, or _avail_in == 0; reads are
3159
                performed for at least two bytes (required for the zip translate_eol
3160
                option -- not supported here).
3161
             </summary>
3162
        </member>
3163
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflate_fast(System.Int32)">
3164
            <summary>
3165
             Compress as much as possible from the input stream, return the current
3166
             block state.
3167
             This function does not perform lazy evaluation of matches and inserts
3168
             new strings in the dictionary only for unmatched strings or for short
3169
             matches. It is used only for the fast compression options.
3170
             </summary>
3171
        </member>
3172
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflate_slow(System.Int32)">
3173
            <summary>
3174
             Same as above, but achieves better compression. We use a lazy
3175
             evaluation for matches: a match is finally adopted only if there is
3176
             no better match at the next Window position.
3177
            </summary>
3178
        </member>
3179
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.longest_match(System.Int32)">
3180
            <summary>
3181
            Finds the longest matching data part
3182
            </summary>
3183
        </member>
3184
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflateInit(ComponentAce.Compression.Libs.ZLib.ZStream,System.Int32,System.Int32)">
3185
            <summary>
3186
            Deflate algorithm initialization
3187
            </summary>
3188
            <param name="strm">ZStream object</param>
3189
            <param name="level">Compression level</param>
3190
            <param name="bits">Window bits</param>
3191
            <returns>A result code</returns>
3192
        </member>
3193
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflateInit(ComponentAce.Compression.Libs.ZLib.ZStream,System.Int32)">
3194
            <summary>
3195
            Initializes deflate algorithm
3196
            </summary>
3197
            <param name="strm">ZStream object</param>
3198
            <param name="level">Compression level</param>
3199
            <returns>Operation result result code</returns>
3200
        </member>
3201
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflateInit2(ComponentAce.Compression.Libs.ZLib.ZStream,System.Int32,System.Int32,System.Int32,System.Int32,ComponentAce.Compression.Libs.ZLib.CompressionStrategy)">
3202
            <summary>
3203
            Deflate algorithm initialization
3204
            </summary>
3205
            <param name="strm">ZStream object</param>
3206
            <param name="level">Compression level</param>
3207
            <param name="method">Compression method</param>
3208
            <param name="windowBits">Window bits</param>
3209
            <param name="memLevel">Memory level</param>
3210
            <param name="strategy">Compression strategy</param>
3211
            <returns>Operation result code</returns>
3212
        </member>
3213
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflateReset(ComponentAce.Compression.Libs.ZLib.ZStream)">
3214
            <summary>
3215
            Resets the current state of deflate object
3216
            </summary>
3217
        </member>
3218
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflateEnd">
3219
            <summary>
3220
            Finish compression with deflate algorithm
3221
            </summary>
3222
        </member>
3223
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflateParams(ComponentAce.Compression.Libs.ZLib.ZStream,System.Int32,ComponentAce.Compression.Libs.ZLib.CompressionStrategy)">
3224
            <summary>
3225
            Sets deflate algorithm parameters
3226
            </summary>
3227
        </member>
3228
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflateSetDictionary(ComponentAce.Compression.Libs.ZLib.ZStream,System.Byte[],System.Int32)">
3229
            <summary>
3230
            Sets deflate dictionary
3231
            </summary>
3232
        </member>
3233
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.deflate(ComponentAce.Compression.Libs.ZLib.ZStream,ComponentAce.Compression.Libs.ZLib.FlushStrategy)">
3234
            <summary>
3235
            Performs data compression with the deflate algorithm
3236
            </summary>
3237
        </member>
3238
        <member name="M:ComponentAce.Compression.Libs.ZLib.Deflate.#cctor">
3239
            <summary>
3240
            Static constructor initializes config_table
3241
            </summary>
3242
        </member>
3243
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.mode">
3244
            <summary>
3245
            current inflate_block mode 
3246
            </summary>
3247
        </member>
3248
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.left">
3249
            <summary>
3250
            if STORED, bytes left to copy 
3251
            </summary>
3252
        </member>
3253
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.table">
3254
            <summary>
3255
            table lengths (14 bits) 
3256
            </summary>
3257
        </member>
3258
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.index">
3259
            <summary>
3260
            index into blens (or border) 
3261
            </summary>
3262
        </member>
3263
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.blens">
3264
            <summary>
3265
            bit lengths of codes 
3266
            </summary>
3267
        </member>
3268
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.bb">
3269
            <summary>
3270
            bit length tree depth 
3271
            </summary>
3272
        </member>
3273
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.tb">
3274
            <summary>
3275
            bit length decoding tree 
3276
            </summary>
3277
        </member>
3278
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.codes">
3279
            <summary>
3280
            if CODES, current state 
3281
            </summary>
3282
        </member>
3283
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.last">
3284
            <summary>
3285
            true if this block is the last block 
3286
            </summary>
3287
        </member>
3288
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.bitk">
3289
            <summary>
3290
            bits in bit buffer 
3291
            </summary>
3292
        </member>
3293
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.bitb">
3294
            <summary>
3295
            bit buffer 
3296
            </summary>
3297
        </member>
3298
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.hufts">
3299
            <summary>
3300
            single malloc for tree space 
3301
            </summary>
3302
        </member>
3303
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.window">
3304
            <summary>
3305
            sliding Window 
3306
            </summary>
3307
        </member>
3308
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.end">
3309
            <summary>
3310
            one byte after sliding Window 
3311
            </summary>
3312
        </member>
3313
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.read">
3314
            <summary>
3315
            Window ReadPos pointer 
3316
            </summary>
3317
        </member>
3318
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.write">
3319
            <summary>
3320
            Window WritePos pointer 
3321
            </summary>
3322
        </member>
3323
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.needCheck">
3324
            <summary>
3325
            need check
3326
            </summary>
3327
        </member>
3328
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfBlocks.check">
3329
            <summary>
3330
            check on output 
3331
            </summary>
3332
        </member>
3333
        <member name="P:ComponentAce.Compression.Libs.ZLib.InfBlocks.Window">
3334
            <summary>
3335
            sliding window 
3336
            </summary>
3337
        </member>
3338
        <member name="P:ComponentAce.Compression.Libs.ZLib.InfBlocks.End">
3339
            <summary>
3340
            one byte after sliding Window 
3341
            </summary>
3342
        </member>
3343
        <member name="P:ComponentAce.Compression.Libs.ZLib.InfBlocks.ReadPos">
3344
            <summary>
3345
            Window ReadPos pointer 
3346
            </summary>
3347
        </member>
3348
        <member name="P:ComponentAce.Compression.Libs.ZLib.InfBlocks.WritePos">
3349
            <summary>
3350
            Window WritePos pointer 
3351
            </summary>
3352
        </member>
3353
        <member name="P:ComponentAce.Compression.Libs.ZLib.InfBlocks.BitK">
3354
            <summary>
3355
            bits in bit buffer 
3356
            </summary>
3357
        </member>
3358
        <member name="P:ComponentAce.Compression.Libs.ZLib.InfBlocks.BitB">
3359
            <summary>
3360
            bit buffer 
3361
            </summary>
3362
        </member>
3363
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfBlocks.reset(ComponentAce.Compression.Libs.ZLib.ZStream,System.Int64[])">
3364
            <summary>
3365
            Resets this InfBlocks class instance
3366
            </summary>
3367
        </member>
3368
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfBlocks.proc(ComponentAce.Compression.Libs.ZLib.ZStream,System.Int32)">
3369
            <summary>
3370
            Block processing functions
3371
            </summary>
3372
        </member>
3373
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfBlocks.free(ComponentAce.Compression.Libs.ZLib.ZStream)">
3374
            <summary>
3375
            Frees inner buffers
3376
            </summary>
3377
        </member>
3378
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfBlocks.set_dictionary(System.Byte[],System.Int32,System.Int32)">
3379
            <summary>
3380
            Sets dictionary
3381
            </summary>
3382
        </member>
3383
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfBlocks.sync_point">
3384
            <summary>
3385
             Returns true if inflate is currently at the End of a block generated
3386
             by Z_SYNC_FLUSH or Z_FULL_FLUSH. 
3387
             </summary>
3388
        </member>
3389
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfBlocks.inflate_flush(ComponentAce.Compression.Libs.ZLib.ZStream,System.Int32)">
3390
            <summary>
3391
            copy as much as possible from the sliding Window to the output area
3392
            </summary>
3393
        </member>
3394
        <member name="T:ComponentAce.Compression.Libs.ZLib.InflateCodesMode">
3395
            <summary>
3396
            Inflate codes mode
3397
            </summary>
3398
        </member>
3399
        <member name="T:ComponentAce.Compression.Libs.ZLib.InfCodes">
3400
            <summary>
3401
            This class is used by the InfBlocks class
3402
            </summary>
3403
        </member>
3404
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.mode">
3405
            <summary>
3406
            current inflate_codes mode
3407
            </summary>
3408
        </member>
3409
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.count">
3410
            <summary>
3411
            length
3412
            </summary>        
3413
        </member>
3414
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.tree">
3415
            <summary>
3416
            pointer into tree
3417
            </summary>
3418
        </member>
3419
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.tree_index">
3420
            <summary>
3421
            current index of the tree
3422
            </summary>
3423
        </member>
3424
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.need">
3425
            <summary>
3426
            
3427
            </summary>
3428
        </member>
3429
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.lbits">
3430
            <summary>
3431
            ltree bits decoded per branch
3432
            </summary>
3433
        </member>
3434
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.dbits">
3435
            <summary>
3436
            dtree bits decoded per branch
3437
            </summary>
3438
        </member>
3439
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.ltree">
3440
            <summary>
3441
            literal/length/eob tree
3442
            </summary>
3443
        </member>
3444
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.ltree_index">
3445
            <summary>
3446
            literal/length/eob tree index
3447
            </summary>
3448
        </member>
3449
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.dtree">
3450
            <summary>
3451
            distance tree
3452
            </summary>
3453
        </member>
3454
        <member name="F:ComponentAce.Compression.Libs.ZLib.InfCodes.dtree_index">
3455
            <summary>
3456
            distance tree index
3457
            </summary>
3458
        </member>
3459
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfCodes.#ctor(System.Int32,System.Int32,System.Int32[],System.Int32,System.Int32[],System.Int32,ComponentAce.Compression.Libs.ZLib.ZStream)">
3460
            <summary>
3461
            Constructor which takes literal, distance trees, corresponding bites decoded for branches, corresponding indexes and a ZStream object 
3462
            </summary>        
3463
        </member>
3464
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfCodes.#ctor(System.Int32,System.Int32,System.Int32[],System.Int32[],ComponentAce.Compression.Libs.ZLib.ZStream)">
3465
            <summary>
3466
            Constructor which takes literal, distance trees, corresponding bites decoded for branches and a ZStream object 
3467
            </summary>   
3468
        </member>
3469
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfCodes.proc(ComponentAce.Compression.Libs.ZLib.InfBlocks,ComponentAce.Compression.Libs.ZLib.ZStream,System.Int32)">
3470
            <summary>
3471
            Block processing method
3472
            </summary>
3473
            <param name="s">An instance of the InfBlocks class</param>
3474
            <param name="z">A ZStream object</param>
3475
            <param name="r">A result code</param>
3476
        </member>
3477
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfCodes.free(ComponentAce.Compression.Libs.ZLib.ZStream)">
3478
            <summary>
3479
            Frees allocated resources
3480
            </summary>
3481
        </member>
3482
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfCodes.inflate_fast(System.Int32,System.Int32,System.Int32[],System.Int32,System.Int32[],System.Int32,ComponentAce.Compression.Libs.ZLib.InfBlocks,ComponentAce.Compression.Libs.ZLib.ZStream)">
3483
            <summary>
3484
            Fast inflate procedure. Called with number of bytes left to WritePos in Window at least 258
3485
            (the maximum string length) and number of input bytes available
3486
            at least ten.  The ten bytes are six bytes for the longest length/
3487
            distance pair plus four bytes for overloading the bit buffer.
3488
            </summary>
3489
        </member>
3490
        <member name="T:ComponentAce.Compression.Libs.ZLib.InflateMode">
3491
            <summary>
3492
            This enumeration contains modes of inflate processing
3493
            </summary>
3494
        </member>
3495
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.METHOD">
3496
            <summary>
3497
            waiting for method byte
3498
            </summary>
3499
        </member>
3500
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.FLAG">
3501
            <summary>
3502
            waiting for flag byte
3503
            </summary>
3504
        </member>
3505
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.DICT4">
3506
            <summary>
3507
            four dictionary check bytes to go
3508
            </summary>
3509
        </member>
3510
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.DICT3">
3511
            <summary>
3512
            three dictionary check bytes to go
3513
            </summary>
3514
        </member>
3515
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.DICT2">
3516
            <summary>
3517
            two dictionary check bytes to go
3518
            </summary>
3519
        </member>
3520
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.DICT1">
3521
            <summary>
3522
            one dictionary check byte to go
3523
            </summary>
3524
        </member>
3525
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.DICT0">
3526
            <summary>
3527
            waiting for inflateSetDictionary
3528
            </summary>
3529
        </member>
3530
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.BLOCKS">
3531
            <summary>
3532
            decompressing blocks
3533
            </summary>
3534
        </member>
3535
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.CHECK4">
3536
            <summary>
3537
            four check bytes to go
3538
            </summary>
3539
        </member>
3540
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.CHECK3">
3541
            <summary>
3542
            three check bytes to go
3543
            </summary>
3544
        </member>
3545
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.CHECK2">
3546
            <summary>
3547
            two check bytes to go
3548
            </summary>
3549
        </member>
3550
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.CHECK1">
3551
            <summary>
3552
            one check byte to go
3553
            </summary>
3554
        </member>
3555
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.DONE">
3556
            <summary>
3557
            finished check, done
3558
            </summary>
3559
        </member>
3560
        <member name="F:ComponentAce.Compression.Libs.ZLib.InflateMode.BAD">
3561
            <summary>
3562
            got an error--stay here
3563
            </summary>
3564
        </member>
3565
        <member name="F:ComponentAce.Compression.Libs.ZLib.Inflate.mode">
3566
            <summary>
3567
            current inflate mode
3568
            </summary>
3569
        </member>
3570
        <member name="F:ComponentAce.Compression.Libs.ZLib.Inflate.method">
3571
            <summary>
3572
            if FLAGS, method byte
3573
            </summary>
3574
        </member>
3575
        <member name="F:ComponentAce.Compression.Libs.ZLib.Inflate.was">
3576
            <summary>
3577
            computed check value
3578
            </summary>
3579
        </member>
3580
        <member name="F:ComponentAce.Compression.Libs.ZLib.Inflate.need">
3581
            <summary>
3582
            stream check value
3583
            </summary>
3584
        </member>
3585
        <member name="F:ComponentAce.Compression.Libs.ZLib.Inflate.marker">
3586
            <summary>
3587
            if BAD, inflateSync's marker bytes count
3588
            </summary>
3589
        </member>
3590
        <member name="F:ComponentAce.Compression.Libs.ZLib.Inflate.nowrap">
3591
            <summary>
3592
            flag for no wrapper
3593
            </summary>
3594
        </member>
3595
        <member name="F:ComponentAce.Compression.Libs.ZLib.Inflate.wbits">
3596
            <summary>
3597
            log2(Window size)  (8..15, defaults to 15)
3598
            </summary>
3599
        </member>
3600
        <member name="F:ComponentAce.Compression.Libs.ZLib.Inflate.blocks">
3601
            <summary>
3602
            current inflate_blocks state
3603
            </summary>
3604
        </member>
3605
        <member name="M:ComponentAce.Compression.Libs.ZLib.Inflate.inflateReset(ComponentAce.Compression.Libs.ZLib.ZStream)">
3606
            <summary>
3607
            Resets the Inflate algorithm
3608
            </summary>
3609
            <param name="z">A ZStream object</param>
3610
            <returns>A result code</returns>
3611
        </member>
3612
        <member name="M:ComponentAce.Compression.Libs.ZLib.Inflate.inflateEnd(ComponentAce.Compression.Libs.ZLib.ZStream)">
3613
            <summary>
3614
            Finishes the inflate algorithm processing
3615
            </summary>
3616
            <param name="z">A ZStream object</param>
3617
            <returns>Operation result code</returns>
3618
        </member>
3619
        <member name="M:ComponentAce.Compression.Libs.ZLib.Inflate.inflateInit(ComponentAce.Compression.Libs.ZLib.ZStream,System.Int32)">
3620
            <summary>
3621
            Initializes the inflate algorithm
3622
            </summary>
3623
            <param name="z">A ZStream object</param>
3624
            <param name="windowBits">Window size</param>
3625
            <returns>Operation result code</returns>
3626
        </member>
3627
        <member name="M:ComponentAce.Compression.Libs.ZLib.Inflate.inflate(ComponentAce.Compression.Libs.ZLib.ZStream,ComponentAce.Compression.Libs.ZLib.FlushStrategy)">
3628
            <summary>
3629
            Runs inflate algorithm
3630
            </summary>
3631
            <param name="z">A ZStream object</param>
3632
            <param name="flush">Flush strategy</param>
3633
            <returns>Operation result code</returns>
3634
        </member>
3635
        <member name="M:ComponentAce.Compression.Libs.ZLib.Inflate.inflateSetDictionary(ComponentAce.Compression.Libs.ZLib.ZStream,System.Byte[],System.Int32)">
3636
            <summary>
3637
            Sets dictionary for the inflate operation
3638
            </summary>
3639
            <param name="z">A ZStream object</param>
3640
            <param name="dictionary">An array of byte - dictionary</param>
3641
            <param name="dictLength">Dictionary length</param>
3642
            <returns>Operation result code</returns>
3643
        </member>
3644
        <member name="M:ComponentAce.Compression.Libs.ZLib.Inflate.inflateSync(ComponentAce.Compression.Libs.ZLib.ZStream)">
3645
            <summary>
3646
            Inflate synchronization
3647
            </summary>
3648
            <param name="z">A ZStream object</param>
3649
            <returns>Operation result code</returns>
3650
        </member>
3651
        <member name="M:ComponentAce.Compression.Libs.ZLib.Inflate.inflateSyncPoint(ComponentAce.Compression.Libs.ZLib.ZStream)">
3652
            <summary>
3653
             Returns true if inflate is currently at the End of a block generated
3654
             by Z_SYNC_FLUSH or Z_FULL_FLUSH. This function is used by one PPP
3655
             implementation to provide an additional safety check. PPP uses Z_SYNC_FLUSH
3656
             but removes the length bytes of the resulting empty stored block. When
3657
             decompressing, PPP checks that at the End of input packet, inflate is
3658
             waiting for these length bytes.
3659
             </summary>
3660
        </member>
3661
        <member name="M:ComponentAce.Compression.Libs.ZLib.GzipHeader.CreateRemover(ComponentAce.Compression.Libs.ZLib.ZStream)">
3662
            <summary>
3663
            Creates header remover.
3664
            As long as header is not completed, call to Remover.MoveNext() returns true and
3665
            adjust state of z.
3666
            </summary>
3667
            <param name="z">Stream where gzip header will appear.</param>
3668
            <returns></returns>
3669
        </member>
3670
        <member name="T:ComponentAce.Compression.Libs.ZLib.InfTreeUtil">
3671
            <summary>
3672
            Contains utility information for the InfTree class
3673
            </summary>
3674
        </member>
3675
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfTree.huft_build(System.Int32[],System.Int32,System.Int32,System.Int32,System.Int32[],System.Int32[],System.Int32[],System.Int32[],System.Int32[],System.Int32[],System.Int32[])">
3676
            <summary>
3677
            Given a list of code lengths and a maximum table size, make a set of
3678
            tables to decode that set of codes.  
3679
            </summary>
3680
            <returns>Return (int)ZLibResultCode.Z_OK on success, (int)ZLibResultCode.Z_DATA_ERROR if the given code set is incomplete (the tables are still built in this case), (int)ZLibResultCode.Z_DATA_ERROR if the input is invalid (an over-subscribed set of lengths), or (int)ZLibResultCode.Z_DATA_ERROR if not enough memory.
3681
            </returns>
3682
        </member>
3683
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfTree.inflate_trees_bits(System.Int32[],System.Int32[],System.Int32[],System.Int32[],ComponentAce.Compression.Libs.ZLib.ZStream)">
3684
            <summary>
3685
            Build trees
3686
            </summary>
3687
        </member>
3688
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfTree.inflate_trees_dynamic(System.Int32,System.Int32,System.Int32[],System.Int32[],System.Int32[],System.Int32[],System.Int32[],System.Int32[],ComponentAce.Compression.Libs.ZLib.ZStream)">
3689
            <summary>
3690
            Builds dynamic trees
3691
            </summary>
3692
        </member>
3693
        <member name="M:ComponentAce.Compression.Libs.ZLib.InfTree.inflate_trees_fixed(System.Int32[],System.Int32[],System.Int32[][],System.Int32[][],ComponentAce.Compression.Libs.ZLib.ZStream)">
3694
            <summary>
3695
            Build fixed trees
3696
            </summary>
3697
        </member>
3698
        <member name="F:ComponentAce.Compression.Libs.ZLib.StaticTree.MAX_BL_BITS">
3699
            <summary>
3700
             Bit length codes must not exceed MAX_BL_BITS bits
3701
            </summary>
3702
        </member>
3703
        <member name="T:ComponentAce.Compression.Libs.ZLib.Tree">
3704
            <summary>
3705
            This class represents a tree and is used in the Deflate class
3706
            </summary>
3707
        </member>
3708
        <member name="F:ComponentAce.Compression.Libs.ZLib.Tree.dyn_tree">
3709
            <summary>
3710
            The dynamic tree
3711
            </summary>
3712
        </member>
3713
        <member name="F:ComponentAce.Compression.Libs.ZLib.Tree.max_code">
3714
            <summary>
3715
            Largest code with non zero frequency
3716
            </summary>
3717
        </member>
3718
        <member name="F:ComponentAce.Compression.Libs.ZLib.Tree.stat_desc">
3719
            <summary>
3720
            the corresponding static tree
3721
            </summary>
3722
        </member>
3723
        <member name="P:ComponentAce.Compression.Libs.ZLib.Tree.DynTree">
3724
            <summary>
3725
            The dynamic tree
3726
            </summary>
3727
        </member>
3728
        <member name="P:ComponentAce.Compression.Libs.ZLib.Tree.MaxCode">
3729
            <summary>
3730
            Largest code with non zero frequency
3731
            </summary>
3732
        </member>
3733
        <member name="P:ComponentAce.Compression.Libs.ZLib.Tree.StatDesc">
3734
            <summary>
3735
            the corresponding static tree
3736
            </summary>
3737
        </member>
3738
        <member name="M:ComponentAce.Compression.Libs.ZLib.Tree.d_code(System.Int32)">
3739
            <summary>
3740
            Mapping from a distance to a distance code. dist is the distance - 1 and
3741
            must not have side effects. _dist_code[256] and _dist_code[257] are never
3742
            used.
3743
            </summary>
3744
        </member>
3745
        <member name="M:ComponentAce.Compression.Libs.ZLib.Tree.gen_bitlen(ComponentAce.Compression.Libs.ZLib.Deflate)">
3746
            <summary>
3747
             Compute the optimal bit lengths for a tree and update the total bit length
3748
             for the current block.
3749
             IN assertion: the fields freq and dad are set, heap[heap_max] and
3750
                above are the tree nodes sorted by increasing frequency.
3751
             OUT assertions: the field count is set to the optimal bit length, the
3752
                 array bl_count contains the frequencies for each bit length.
3753
                 The length opt_len is updated; static_len is also updated if stree is
3754
                 not null.
3755
            </summary>
3756
        </member>
3757
        <member name="M:ComponentAce.Compression.Libs.ZLib.Tree.build_tree(ComponentAce.Compression.Libs.ZLib.Deflate)">
3758
            <summary>
3759
             Construct one Huffman tree and assigns the code bit strings and lengths.
3760
             Update the total bit length for the current block.
3761
             IN assertion: the field freq is set for all tree elements.
3762
             OUT assertions: the fields count and code are set to the optimal bit length
3763
                 and corresponding code. The length opt_len is updated; static_len is
3764
                 also updated if stree is not null. The field max_code is set.
3765
            </summary>
3766
        </member>
3767
        <member name="M:ComponentAce.Compression.Libs.ZLib.Tree.gen_codes(System.Int16[],System.Int32,System.Int16[])">
3768
            <summary>
3769
             Generate the codes for a given tree and bit counts (which need not be
3770
             optimal).
3771
             IN assertion: the array bl_count contains the bit length statistics for
3772
             the given tree and the field count is set for all tree elements.
3773
             OUT assertion: the field code is set for all tree elements of non
3774
                 zero code length.
3775
            </summary>
3776
        </member>
3777
        <member name="M:ComponentAce.Compression.Libs.ZLib.Tree.bi_reverse(System.Int32,System.Int32)">
3778
            <summary>
3779
             Reverse the first count bits of a code, using straightforward code (a faster
3780
             method would use a table)
3781
            </summary>
3782
        </member>
3783
        <member name="T:ComponentAce.Compression.Libs.ZLib.ZLibCompressionLevel">
3784
            <summary>
3785
            Some constants for specifying compression levels. Methods which takes a compression level as a parameter expects an integer value from 0 to 9. You can either specify an integer value or use constants for some most widely used compression levels.
3786
            </summary>
3787
        </member>
3788
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibCompressionLevel.Z_NO_COMPRESSION">
3789
            <summary>
3790
             No compression should be used at all.
3791
            </summary>
3792
        </member>
3793
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibCompressionLevel.Z_BEST_SPEED">
3794
            <summary>
3795
            Minimal compression, but greatest speed.
3796
            </summary>
3797
        </member>
3798
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibCompressionLevel.Z_BEST_COMPRESSION">
3799
            <summary>
3800
            Maximum compression, but slowest.
3801
            </summary>
3802
        </member>
3803
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibCompressionLevel.Z_DEFAULT_COMPRESSION">
3804
            <summary>
3805
            Select default compression level (good compression, good speed).
3806
            </summary>
3807
        </member>
3808
        <member name="T:ComponentAce.Compression.Libs.ZLib.CompressionStrategy">
3809
            <summary>
3810
            Compression strategies. The strategy parameter is used to tune the compression algorithm. The strategy parameter only affects the compression ratio but not the correctness of the compressed output even if it is not set appropriately.
3811
            </summary>
3812
        </member>
3813
        <member name="F:ComponentAce.Compression.Libs.ZLib.CompressionStrategy.Z_FILTERED">
3814
            <summary>
3815
            This strategy is designed for filtered data. Data which consists of mostly small values, with random distribution should use Z_FILTERED. With this strategy, less string matching is performed.
3816
            </summary>
3817
        </member>
3818
        <member name="F:ComponentAce.Compression.Libs.ZLib.CompressionStrategy.Z_HUFFMAN_ONLY">
3819
            <summary>
3820
            Z_HUFFMAN_ONLY forces Huffman encoding only (no string match)
3821
            </summary>
3822
        </member>
3823
        <member name="F:ComponentAce.Compression.Libs.ZLib.CompressionStrategy.Z_DEFAULT_STRATEGY">
3824
            <summary>
3825
            The default strategy is the most commonly used. With this strategy, string matching and huffman compression are balanced.
3826
            </summary>
3827
        </member>
3828
        <member name="T:ComponentAce.Compression.Libs.ZLib.FlushStrategy">
3829
            <summary>
3830
            Flush strategies
3831
            </summary>
3832
        </member>
3833
        <member name="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_NO_FLUSH">
3834
            <summary>
3835
              Do not internalFlush data, but just write data as normal to the output buffer. This is the normal way in which data is written to the output buffer.
3836
            </summary>
3837
        </member>
3838
        <member name="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_PARTIAL_FLUSH">
3839
            <summary>
3840
            Obsolete. You should use Z_SYNC_FLUSH instead.
3841
            </summary>        
3842
        </member>
3843
        <member name="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_SYNC_FLUSH">
3844
            <summary>
3845
            All pending output is flushed to the output buffer and the output is aligned on a byte boundary, so that the decompressor can get all input data available so far.
3846
            </summary>
3847
        </member>
3848
        <member name="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FULL_FLUSH">
3849
            <summary>
3850
            All output is flushed as with Z_SYNC_FLUSH, and the compression state is reset so that decompression can restart from this point if previous compressed data has been damaged or if random access is desired. Using Z_FULL_FLUSH too often can seriously degrade the compression. ZLib_InflateSync will locate points in the compression string where a full has been performed.
3851
            </summary>
3852
        </member>
3853
        <member name="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH">
3854
            <summary>
3855
            Notifies the module that the input has now been exhausted. Pending input is processed, pending output is flushed and calls return with Z_STREAM_END if there was enough output space.
3856
            </summary>
3857
        </member>
3858
        <member name="T:ComponentAce.Compression.Libs.ZLib.ZLibResultCode">
3859
            <summary>
3860
            Results of operations in ZLib library
3861
            </summary>
3862
        </member>
3863
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK">
3864
            <summary>
3865
             No failure was encountered, the operation completed without problem.
3866
            </summary>
3867
        </member>
3868
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END">
3869
            <summary>
3870
            No failure was encountered, and the input has been exhausted.
3871
            </summary>
3872
        </member>
3873
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_NEED_DICT">
3874
            <summary>
3875
            A preset dictionary is required for decompression of the data.
3876
            </summary>
3877
        </member>
3878
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_ERRNO">
3879
            <summary>
3880
            An internal error occurred
3881
            </summary>
3882
        </member>
3883
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR">
3884
            <summary>
3885
            The stream structure was inconsistent
3886
            </summary>
3887
        </member>
3888
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_DATA_ERROR">
3889
            <summary>
3890
            Input data has been corrupted (for decompression).
3891
            </summary>
3892
        </member>
3893
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_MEM_ERROR">
3894
            <summary>
3895
            Memory allocation failed.
3896
            </summary>
3897
        </member>
3898
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_BUF_ERROR">
3899
            <summary>
3900
            There was not enough space in the output buffer.
3901
            </summary>
3902
        </member>
3903
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_VERSION_ERROR">
3904
            <summary>
3905
            The version supplied does not match that supported by the ZLib module.
3906
            </summary>
3907
        </member>
3908
        <member name="T:ComponentAce.Compression.Libs.ZLib.DeflateState">
3909
            <summary>
3910
            States of deflate operation
3911
            </summary>
3912
        </member>
3913
        <member name="T:ComponentAce.Compression.Libs.ZLib.BlockType">
3914
            <summary>
3915
            Data block types, i.e. binary or ascii text
3916
            </summary>
3917
        </member>
3918
        <member name="T:ComponentAce.Compression.Libs.ZLib.ZLibUtil">
3919
            <summary>
3920
            Helper class
3921
            </summary>
3922
        </member>
3923
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.CopyLargeArrayToSmall.CopyData">
3924
            <summary>
3925
            Copies large array which was passed as srcBuf to the Initialize method into the destination array which were passes as destBuff
3926
            </summary>
3927
            <returns>The number of bytes copied</returns>
3928
        </member>
3929
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibUtil.MAX_WBITS">
3930
            <summary>
3931
            Max Window size
3932
            </summary>
3933
        </member>
3934
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibUtil.PRESET_DICT">
3935
            <summary>
3936
            preset dictionary flag in zlib header
3937
            </summary>
3938
        </member>
3939
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibUtil.zLibBufSize">
3940
            <summary>
3941
            The size of the buffer
3942
            </summary>
3943
        </member>
3944
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibUtil.Z_DEFLATED">
3945
            <summary>
3946
            Deflate compression method index
3947
            </summary>
3948
        </member>
3949
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.Identity(System.Int64)">
3950
            <summary>
3951
            This method returns the literal value received
3952
            </summary>
3953
            <param name="literal">The literal to return</param>
3954
            <returns>The received value</returns>
3955
        </member>
3956
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.Identity(System.UInt64)">
3957
            <summary>
3958
            This method returns the literal value received
3959
            </summary>
3960
            <param name="literal">The literal to return</param>
3961
            <returns>The received value</returns>
3962
        </member>
3963
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.Identity(System.Single)">
3964
            <summary>
3965
            This method returns the literal value received
3966
            </summary>
3967
            <param name="literal">The literal to return</param>
3968
            <returns>The received value</returns>
3969
        </member>
3970
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.Identity(System.Double)">
3971
            <summary>
3972
            This method returns the literal value received
3973
            </summary>
3974
            <param name="literal">The literal to return</param>
3975
            <returns>The received value</returns>
3976
        </member>
3977
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.URShift(System.Int32,System.Int32)">
3978
            <summary>
3979
            Performs an unsigned bitwise right shift with the specified number
3980
            </summary>
3981
            <param name="number">Number to operate on</param>
3982
            <param name="bits">Ammount of bits to shift</param>
3983
            <returns>The resulting number from the shift operation</returns>
3984
        </member>
3985
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.URShift(System.Int32,System.Int64)">
3986
            <summary>
3987
            Performs an unsigned bitwise right shift with the specified number
3988
            </summary>
3989
            <param name="number">Number to operate on</param>
3990
            <param name="bits">Ammount of bits to shift</param>
3991
            <returns>The resulting number from the shift operation</returns>
3992
        </member>
3993
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.URShift(System.Int64,System.Int32)">
3994
            <summary>
3995
            Performs an unsigned bitwise right shift with the specified number
3996
            </summary>
3997
            <param name="number">Number to operate on</param>
3998
            <param name="bits">Ammount of bits to shift</param>
3999
            <returns>The resulting number from the shift operation</returns>
4000
        </member>
4001
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.URShift(System.Int64,System.Int64)">
4002
            <summary>
4003
            Performs an unsigned bitwise right shift with the specified number
4004
            </summary>
4005
            <param name="number">Number to operate on</param>
4006
            <param name="bits">Ammount of bits to shift</param>
4007
            <returns>The resulting number from the shift operation</returns>
4008
        </member>
4009
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.ReadInput(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
4010
            <summary>Reads a number of characters from the current source Stream and writes the data to the target array at the specified index.</summary>
4011
            <param name="sourceStream">The source Stream to ReadPos from.</param>
4012
            <param name="target">Contains the array of characters ReadPos from the source Stream.</param>
4013
            <param name="start">The starting index of the target array.</param>
4014
            <param name="count">The maximum number of characters to ReadPos from the source Stream.</param>
4015
            <returns>The number of characters ReadPos. The number will be less than or equal to count depending on the data available in the source Stream. Returns -1 if the End of the stream is reached.</returns>
4016
        </member>
4017
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.ReadInput(System.IO.TextReader,System.Byte[],System.Int32,System.Int32)">
4018
            <summary>Reads a number of characters from the current source TextReader and writes the data to the target array at the specified index.</summary>
4019
            <param name="sourceTextReader">The source TextReader to ReadPos from</param>
4020
            <param name="target">Contains the array of characteres ReadPos from the source TextReader.</param>
4021
            <param name="start">The starting index of the target array.</param>
4022
            <param name="count">The maximum number of characters to ReadPos from the source TextReader.</param>
4023
            <returns>The number of characters ReadPos. The number will be less than or equal to count depending on the data available in the source TextReader. Returns -1 if the End of the stream is reached.</returns>
4024
        </member>
4025
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.ToByteArray(System.String)">
4026
            <summary>
4027
            Converts a string to an array of bytes
4028
            </summary>
4029
            <param name="sourceString">The string to be converted</param>
4030
            <returns>The new array of bytes</returns>
4031
        </member>
4032
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZLibUtil.ToCharArray(System.Byte[])">
4033
            <summary>
4034
            Converts an array of bytes to an array of chars
4035
            </summary>
4036
            <param name="byteArray">The array of bytes to convert</param>
4037
            <returns>The new array of chars</returns>
4038
        </member>
4039
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZLibUtil.DIST_CODE_LEN">
4040
            <summary>
4041
            see definition of array dist_code below
4042
            </summary>
4043
        </member>
4044
        <member name="T:ComponentAce.Compression.Libs.ZLib.ZStream">
4045
            <summary>
4046
            ZStream is used to store user data to compress/decompress.
4047
            </summary>
4048
        </member>
4049
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream.MAX_MEM_LEVEL">
4050
            <summary>
4051
            Maximum memory level
4052
            </summary>
4053
        </member>
4054
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._next_in">
4055
            <summary>
4056
            Next input byte array
4057
            </summary>
4058
        </member>
4059
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._next_in_index">
4060
            <summary>
4061
            Index of the first byte in the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in">input array</see>.
4062
            </summary>
4063
        </member>
4064
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._avail_in">
4065
            <summary>
4066
            Number of bytes available at _next_in
4067
            </summary>
4068
        </member>
4069
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._total_in">
4070
            <summary>
4071
            total nb of input bytes ReadPos so far
4072
            </summary>
4073
        </member>
4074
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._next_out">
4075
            <summary>
4076
            Byte array for the next output block
4077
            </summary>
4078
        </member>
4079
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._next_out_index">
4080
            <summary>
4081
            Index of the first byte in the _next_out array
4082
            </summary>
4083
        </member>
4084
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._avail_out">
4085
            <summary>
4086
            Remaining free space at _next_out
4087
            </summary>
4088
        </member>
4089
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._total_out">
4090
            <summary>
4091
            Total number of bytes in output array
4092
            </summary>
4093
        </member>
4094
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._msg">
4095
            <summary>
4096
            A string to store operation result message (corresponding to result codes)
4097
            </summary>
4098
        </member>
4099
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._dstate">
4100
            <summary>
4101
            A deflate object to perform data compression
4102
            </summary>
4103
        </member>
4104
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._istate">
4105
            <summary>
4106
            Inflate object to perform data decompression
4107
            </summary>
4108
        </member>
4109
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream.data_type">
4110
            <summary>
4111
            Best guess about the data type: ascii or binary
4112
            </summary>
4113
        </member>
4114
        <member name="F:ComponentAce.Compression.Libs.ZLib.ZStream._adler">
4115
            <summary>
4116
            A checksum computed with Adler algorithm
4117
            </summary>
4118
        </member>
4119
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.adler">
4120
            <summary>
4121
            Adler-32 value for uncompressed data processed so far.
4122
            </summary>
4123
        </member>
4124
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.Data_type">
4125
            <summary>
4126
            Best guess about the data type: ascii or binary
4127
            </summary>
4128
        </member>
4129
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in">
4130
            <summary>
4131
            Gets/Sets the next input byte array.
4132
            </summary>
4133
        </member>
4134
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in_index">
4135
            <summary>
4136
            Index of the first byte in the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in">input array</see>.
4137
            </summary>
4138
        </member>
4139
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in">
4140
            <summary>
4141
            Gets/Sets the number of bytes available in the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in">input buffer</see>.
4142
            </summary>
4143
        </member>
4144
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.total_in">
4145
            <summary>
4146
            Gets/Sets the total number of bytes in the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in">input buffer</see>.
4147
            </summary>
4148
        </member>
4149
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out">
4150
            <summary>
4151
            Gets/Sets the buffer for the next output data.
4152
            </summary>
4153
        </member>
4154
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out_index">
4155
            <summary>
4156
            Gets/Sets the index of the first byte in the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> byte array to write to.
4157
            </summary>
4158
        </member>
4159
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out">
4160
            <summary>
4161
            Gets/Sets the remaining free space in the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> buffer.
4162
            </summary>
4163
        </member>
4164
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.total_out">
4165
            <summary>
4166
            Gets/Sets the total number of bytes in the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out">output array</see>.
4167
            </summary>
4168
        </member>
4169
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.msg">
4170
            <summary>
4171
            Gets sets the last error message occurred during class operations.
4172
            </summary>
4173
        </member>
4174
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.dstate">
4175
            <summary>
4176
            A deflate object to perform data compression
4177
            </summary>
4178
        </member>
4179
        <member name="P:ComponentAce.Compression.Libs.ZLib.ZStream.istate">
4180
            <summary>
4181
            Inflate object to perform data decompression
4182
            </summary>
4183
        </member>
4184
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateInit">
4185
            <summary>
4186
            Initializes the internal stream state for decompression. The fields <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" />, <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> must be 
4187
            initialized before by the caller. If <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> is not <c>null</c> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> is large 
4188
            enough (the exact value depends on the compression method), <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateInit" /> determines the compression 
4189
            method from the ZLib header and allocates all data structures accordingly; otherwise the allocation will be deferred 
4190
            to the first call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. 
4191
            </summary>
4192
            <returns>
4193
            inflateInit returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_MEM_ERROR" /> if there was not enough memory,  
4194
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_VERSION_ERROR" /> if the ZLib library version is incompatible with the version assumed by the caller. 
4195
            <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.msg" /> is set to <c>null</c> if there is no error message. <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateInit" /> does not perform any decompression 
4196
            apart from reading the ZLib header if present: this will be done by <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. (So <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> 
4197
            may be modified, but <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> are unchanged.)
4198
            </returns>
4199
        </member>
4200
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateInit(System.Int32)">
4201
            <summary>
4202
            This is another version of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateInit" /> with an extra parameter. The fields <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" />, <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> must be 
4203
            initialized before by the caller. If <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> is not <c>null</c> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> is large enough 
4204
            (the exact value depends on the compression method), <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateInit(System.Int32)" /> determines the compression method from 
4205
            the ZLib header and allocates all data structures accordingly; otherwise the allocation will be deferred to the first 
4206
            call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. 
4207
            </summary>
4208
            <param name="windowBits">The <c>windowBits</c> parameter is the base two logarithm of the maximum window size (the size of the history buffer). 
4209
            It should be in the range <c>8..15</c> for this version of the library. The default value is 15 if <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateInit(System.Int32)" /> is used instead.
4210
            If a compressed stream with a larger window size is given as input, <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> will return with the error code 
4211
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_DATA_ERROR" /> instead of trying to allocate a larger window.</param>
4212
            <returns>
4213
            inflateInit returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_MEM_ERROR" /> if there was not enough memory,
4214
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if a parameter is invalid (such as a negative memLevel). <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.msg" /> is set to null 
4215
            if there is no error message. <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateInit(System.Int32)" /> does not perform any decompression apart from reading the ZLib header 
4216
            if present: this will be done by <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. (So <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> may be modified, 
4217
            but <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> are unchanged.)
4218
            </returns>
4219
        </member>
4220
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)">
4221
            <summary>
4222
            <para>This method decompresses as much data as possible, and stops when the input buffer (<see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" />) becomes empty or 
4223
            the output buffer (<see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" />) becomes full. It may some introduce some output latency (reading input without producing any output) 
4224
            except when forced to flush. </para>
4225
            <para>The detailed semantics are as follows. <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> performs one or both of the following actions: </para>
4226
            <para>
4227
            <list type="bullet">
4228
            <item>Decompress more input starting at <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> and update <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> 
4229
            accordingly. If not all input can be processed (because there is not enough room in the output buffer), <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> is updated and 
4230
            processing will resume at this point for the next call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. </item>
4231
            <item>Provide more output starting at <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> and update <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> 
4232
            accordingly. <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> provides as much output as possible, until there is no more input data or no more space in 
4233
            the output buffer (see below about the <paramref name="flush" /> parameter).</item>
4234
            </list>
4235
            </para>
4236
            </summary>
4237
            <param name="flush"><see cref="T:ComponentAce.Compression.Libs.ZLib.FlushStrategy">Flush strategy</see> to use.</param>
4238
            <remarks>
4239
            <para>Before the call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />, the application should ensure that at least one of the actions is possible, by providing 
4240
            more input and/or consuming more output, and updating the next_* and avail_* values accordingly. The application can consume the uncompressed 
4241
            output when it wants, for example when the output buffer is full (<c>avail_out == 0</c>), or after each call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. 
4242
            If <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> and with zero <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" />, it must be called again 
4243
            after making room in the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out">output buffer</see> because there might be more output pending. </para>
4244
            <para>If the parameter <paramref name="flush" /> is set to <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_SYNC_FLUSH" />, <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> flushes 
4245
            as much output as possible to the output buffer. The flushing behavior of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> is not specified for values of 
4246
            the <paramref name="flush" /> parameter other than <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_SYNC_FLUSH" /> and <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH" />, 
4247
            but the current implementation actually flushes as much output as possible anyway. </para>
4248
            <para><see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> should normally be called until it returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END" /> or an error. 
4249
            However if all decompression is to be performed in a single step (a single call of inflate), the parameter <paramref name="flush" /> 
4250
            should be set to <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH" />. In this case all pending input is processed and all pending output is flushed; 
4251
            <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> must be large enough to hold all the uncompressed data. (The size of the uncompressed data may have been 
4252
            saved by the compressor for this purpose.) The next operation on this stream must be <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateEnd" /> to deallocate the decompression 
4253
            state. The use of <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH" /> is never required, but can be used to inform <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> that a faster 
4254
            routine may be used for the single <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> call. </para>
4255
            <para>If a preset dictionary is needed at this point (see <see cref = "M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateSetDictionary(System.Byte[],System.Int32)" />), <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> sets strm-adler 
4256
            to the adler32 checksum of the dictionary chosen by the compressor and returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_NEED_DICT" />; otherwise it 
4257
            sets strm->adler to the adler32 checksum of all output produced so far (that is, <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.total_out" /> bytes) and returns
4258
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" />, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END" /> or an error code as described below. At the end of the stream, 
4259
            <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />) checks that its computed adler32 checksum is equal to that saved by the compressor and returns
4260
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END" /> only if the checksum is correct.</para>
4261
            </remarks>
4262
            <returns>
4263
            <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if some progress has been made (more input processed or more output produced), 
4264
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END" /> if the end of the compressed data has been reached and all uncompressed output has been produced, 
4265
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_NEED_DICT" /> if a preset dictionary is needed at this point, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_DATA_ERROR" /> if 
4266
            the input data was corrupted (input stream not conforming to the ZLib format or incorrect adler32 checksum), 
4267
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if the stream structure was inconsistent (for example if <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> or 
4268
            <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> was <c>null</c>), <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_MEM_ERROR" /> if there was not enough memory, 
4269
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_BUF_ERROR" /> if no progress is possible or if there was not enough room in the output buffer 
4270
            when <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH" /> is used. In the <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_DATA_ERROR" /> case, the application 
4271
            may then call <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateSync" /> to look for a good compression block.
4272
            </returns>
4273
        </member>
4274
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateEnd">
4275
            <summary>
4276
            All dynamically allocated data structures for this stream are freed. This function discards any unprocessed input and does not flush any 
4277
            pending output.
4278
            </summary>
4279
            <returns>
4280
            inflateEnd returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> 
4281
            if the stream state was inconsistent. In the error case, msg may be set but then points to a static string (which must not be deallocated).
4282
            </returns>
4283
        </member>
4284
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateSync">
4285
            <summary>
4286
            Skips invalid compressed data until a full flush point (see the description of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)">deflate with Z_FULL_FLUSH</see>) can be found, 
4287
            or until all available input is skipped. No output is provided.
4288
            </summary>
4289
            <returns>
4290
            <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateSync" /> returns <seec ref="ZLibResultCode.Z_OK" /> if a full flush point has been found, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_BUF_ERROR" />
4291
            if no more input was provided, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_DATA_ERROR" /> if no flush point has been found, or 
4292
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if the stream structure was inconsistent. In the success case, the application may save the current 
4293
            current value of <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.total_in" /> which indicates where valid compressed data was found. In the error case, the application may repeatedly 
4294
            call <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateSync" />, providing more input each time, until success or end of the input data.
4295
            </returns>
4296
        </member>
4297
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateSetDictionary(System.Byte[],System.Int32)">
4298
            <summary>
4299
            Initializes the decompression dictionary from the given uncompressed byte sequence. This function must be called immediately after a call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> if this call returned <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_NEED_DICT" />. The dictionary chosen by the compressor can be determined from the Adler32 value returned by this call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. The compressor and decompresser must use exactly the same dictionary.
4300
            </summary>
4301
            <param name="dictionary">A byte array - a dictionary.</param>
4302
            <param name="dictLength">The length of the dictionary.</param>
4303
            <returns>
4304
            inflateSetDictionary returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if a parameter is invalid (such as <c>null</c> dictionary) or the stream state is inconsistent, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_DATA_ERROR" /> if the given dictionary doesn't match the expected one (incorrect Adler32 value). inflateSetDictionary does not perform any decompression: this will be done by subsequent calls of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />.
4305
            </returns>
4306
        </member>
4307
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateInit(System.Int32)">
4308
            <summary>
4309
            Initializes the internal stream state for compression. 
4310
            </summary>
4311
            <param name="level">An integer value from 0 to 9 indicating the desired compression level.</param>
4312
            <returns>
4313
            deflateInit returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_MEM_ERROR" /> if there was not enough memory, 
4314
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if level is not a valid compression level. <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.msg" /> is set to <c>null</c> if there is 
4315
            no error message. <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateInit(System.Int32)" /> does not perform any compression: this will be done by <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />.
4316
            </returns>
4317
        </member>
4318
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateInit(System.Int32,System.Int32)">
4319
            <summary>
4320
            Initializes the internal stream state for compression. 
4321
            </summary>
4322
            <param name="level">An integer value from 0 to 9 indicating the desired compression level.</param>
4323
            <param name="bits"> The windowBits parameter is the base two logarithm of the window size (the size of the history buffer). It should be in the 
4324
            range 8..15 for this version of the library. Larger values of this parameter result in better compression at the expense of memory usage. 
4325
            The default value is 15 if deflateInit is used instead.</param>
4326
            <returns>
4327
            deflateInit returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_MEM_ERROR" /> if there was not enough memory,
4328
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if level is not a valid compression level. <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.msg" /> is set to <c>null</c> if there 
4329
            is no error message. <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateInit(System.Int32,System.Int32)" /> does not perform any compression: this will be done by <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />.
4330
            </returns>
4331
        </member>
4332
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)">
4333
            <summary>
4334
            <para>Deflate compresses as much data as possible, and stops when the <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in">input buffer</see> becomes empty or the 
4335
            <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out">output buffer</see> becomes full. It may introduce some output latency (reading input without producing any output) 
4336
            except when forced to flush.</para>
4337
            <para>The detailed semantics are as follows. deflate performs one or both of the following actions:
4338
            <list type="bullet">
4339
            <item>Compress more input starting at <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> and update <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> accordingly. 
4340
            If not all input can be processed (because there is not enough room in the output buffer), <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> 
4341
            are updated and processing will resume at this point for the next call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. </item>
4342
            <item>Provide more output starting at <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> and update <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> and <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> accordingly. 
4343
            This action is forced if the parameter flush is non zero. Forcing flush frequently degrades the compression ratio, so this parameter should 
4344
            be set only when necessary (in interactive applications). Some output may be provided even if flush is not set.</item>
4345
            </list>
4346
            </para>
4347
            </summary>
4348
            <param name="flush">The <see cref="T:ComponentAce.Compression.Libs.ZLib.FlushStrategy">flush strategy</see> to use.</param>
4349
            <remarks>
4350
            <para>
4351
            Before the call of <seec ref="deflate" />, the application should ensure that at least one of the actions is possible, by providing 
4352
            more input and/or consuming more output, and updating <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> or <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> accordingly ; <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> 
4353
            should never be zero before the call. The application can consume the compressed output when it wants, for example when the output buffer is full
4354
            (<c>avail_out == 0</c>), or after each call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. If <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> 
4355
            and with zero <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" />, it must be called again after making room in the output buffer because there might be more output pending. 
4356
            </para>
4357
            <para>
4358
            If the parameter <paramref name="flush"/> is set to <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_SYNC_FLUSH" />, all pending output is flushed to the 
4359
            <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out">output buffer</see> and the output is aligned on a byte boundary, so that the decompressor can get all input 
4360
            data available so far. (In particular <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> is zero after the call if enough output space has been provided before the call.) 
4361
            Flushing may degrade compression for some compression algorithms and so it should be used only when necessary. 
4362
            </para>
4363
            <para>
4364
            If flush is set to <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FULL_FLUSH" />, all output is flushed as with <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_SYNC_FLUSH" />, 
4365
            and the compression state is reset so that decompression can restart from this point if previous compressed data has been damaged or if 
4366
            random access is desired. Using <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FULL_FLUSH" /> too often can seriously degrade the compression.
4367
            </para>
4368
            </remarks>
4369
            <returns>
4370
            <para>
4371
            If deflate returns with <c><see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> == 0</c>, this function must be called again with the same value of the flush
4372
            parameter and more output space (updated <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" />), until the flush is complete (<see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> returns with
4373
            non-zero <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" />). 
4374
            </para>
4375
            <para>
4376
            If the parameter <paramref name="flush"/> is set to <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH" />, pending input is processed, pending 
4377
            output is flushed and deflate returns with <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END" /> if there was enough output space ; 
4378
            if deflate returns with <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" />, this function must be called again with <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH" /> 
4379
            and more output space (updated <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" />) but no more input data, until it returns with <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END" /> 
4380
            or an error. After deflate has returned <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END" />, the only possible operation on the stream is
4381
            <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateEnd" />. </para>
4382
            <para>
4383
            <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH" /> can be used immediately after <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateInit(System.Int32)" /> if all the compression is to be 
4384
            done in a single step. In this case, avail_out must be at least 0.1% larger than avail_in plus 12 bytes. If deflate does not return 
4385
            Z_STREAM_END, then it must be called again as described above. 
4386
            </para>
4387
            <para>
4388
            <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> sets strm-> adler to the adler32 checksum of all input read so far (that is, <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.total_in" /> bytes). 
4389
            </para>
4390
            <para>
4391
            <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> may update data_type if it can make a good guess about the input data type (<see cref="T:ComponentAce.Compression.Libs.ZLib.BlockType">Z_ASCII or Z_BINARY</see>).
4392
            In doubt, the data is considered binary. This field is only for information purposes and does not affect the compression algorithm in any manner. 
4393
            </para>
4394
            <para>
4395
            <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if some progress has been made (more input processed or more output produced), 
4396
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_END" /> if all input has been consumed and all output has been produced (only when flush is set to
4397
            <see cref="F:ComponentAce.Compression.Libs.ZLib.FlushStrategy.Z_FINISH" />), <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if the stream state was inconsistent (for example if 
4398
            <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> or <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> was <c>null</c>), <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_BUF_ERROR" /> if no progress is possible
4399
            (for example <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_in" /> or <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> was zero).
4400
            </para>
4401
            </returns>
4402
        </member>
4403
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateEnd">
4404
            <summary>
4405
            All dynamically allocated data structures for this stream are freed. This function discards any unprocessed input and does not flush any pending 
4406
            output.
4407
            </summary>
4408
            <returns>
4409
            deflateEnd returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if the stream state was inconsistent, 
4410
            <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_DATA_ERROR" /> if the stream was freed prematurely (some input or output was discarded). In the error case, 
4411
            <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.msg" /> may be set but then points to a static string (which must not be deallocated).
4412
            </returns>
4413
        </member>
4414
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateParams(System.Int32,ComponentAce.Compression.Libs.ZLib.CompressionStrategy)">
4415
            <summary>
4416
            Dynamically update the compression level and compression strategy. The interpretation of level is as in <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateInit(System.Int32)"/>. 
4417
            This can be used to switch between compression and straight copy of the input data, or to switch to a different kind of input data 
4418
            requiring a different strategy. If the compression level is changed, the input available so far is compressed with the old level 
4419
            (and may be flushed); the new level will take effect only at the next call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />
4420
            </summary>
4421
            <param name="level">An integer value indicating the desired compression level.</param>
4422
            <param name="strategy">A <see cref="T:ComponentAce.Compression.Libs.ZLib.FlushStrategy">flush strategy</see> to use.</param>
4423
            <remarks>
4424
            Before the call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateParams(System.Int32,ComponentAce.Compression.Libs.ZLib.CompressionStrategy)" />, the stream state must be set as for a call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />, since the 
4425
            currently available input may have to be compressed and flushed. In particular, <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> must be non-zero.
4426
            </remarks>
4427
            <returns>
4428
            deflateParams returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if the source stream 
4429
            state was inconsistent or if a parameter was invalid, <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_BUF_ERROR" /> if <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.avail_out" /> was zero.
4430
            </returns>
4431
        </member>
4432
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateSetDictionary(System.Byte[],System.Int32)">
4433
            <summary>
4434
            Initializes the compression dictionary from the given byte sequence without producing any compressed output. This function must be called 
4435
            immediately after <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateInit(System.Int32)" />, before any call of <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. The compressor and decompressor must use 
4436
            exactly the same dictionary (see <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.inflateSetDictionary(System.Byte[],System.Int32)" />).
4437
            </summary>
4438
            <param name="dictionary">A byte array - a dictionary.</param>
4439
            <param name="dictLength">The length of the dictionary byte array</param>
4440
            <remarks>
4441
            <para>
4442
            The dictionary should consist of strings (byte sequences) that are likely to be encountered later in the data to be compressed, 
4443
            with the most commonly used strings preferably put towards the end of the dictionary. Using a dictionary is most useful when the data 
4444
            to be compressed is short and can be predicted with good accuracy; the data can then be compressed better than with the default empty dictionary.
4445
            </para>
4446
            <para>Depending on the size of the compression data structures selected by <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateInit(System.Int32)" />, a part of the dictionary may 
4447
            in effect be discarded, for example if the dictionary is larger than the window size in <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />. Thus the strings most likely 
4448
            to be useful should be put at the end of the dictionary, not at the front.</para>
4449
            <para>Upon return of this function, adler is set to the Adler32 value of the dictionary; the decompresser may later use this value to determine 
4450
            which dictionary has been used by the compressor. (The Adler32 value applies to the whole dictionary even if only a subset of the dictionary 
4451
            is actually used by the compressor.)</para>
4452
            </remarks>
4453
            <returns>
4454
            deflateSetDictionary returns <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_OK" /> if success, or <see cref="F:ComponentAce.Compression.Libs.ZLib.ZLibResultCode.Z_STREAM_ERROR" /> if a parameter 
4455
            is invalid (such as <c>null</c> dictionary) or the stream state is inconsistent (for example if <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> has already been 
4456
            called for this stream or if the compression method is bsort). <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflateSetDictionary(System.Byte[],System.Int32)" /> does not perform any compression: 
4457
            this will be done by <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" />.
4458
            </returns>
4459
        </member>
4460
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.flush_pending">
4461
            <summary>
4462
            Flush as much pending output as possible. All <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> output goes through this function so some applications may wish to 
4463
            modify it to avoid allocating a large <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_out" /> buffer and copying into it.
4464
            </summary>
4465
            <seealso cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.read_buf(System.Byte[],System.Int32,System.Int32)" />
4466
        </member>
4467
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.read_buf(System.Byte[],System.Int32,System.Int32)">
4468
            <summary>
4469
            Read a new buffer from the current input stream, update the adler32 and total number of bytes read.  All <see cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.deflate(ComponentAce.Compression.Libs.ZLib.FlushStrategy)" /> input goes 
4470
            through this function so some applications may wish to modify it to avoid allocating a large <see cref="P:ComponentAce.Compression.Libs.ZLib.ZStream.next_in" /> buffer and copying from it.
4471
            </summary>
4472
            <seealso cref="M:ComponentAce.Compression.Libs.ZLib.ZStream.flush_pending"/>
4473
        </member>
4474
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStream.free">
4475
            <summary>
4476
            Frees all inner <see cref="T:ComponentAce.Compression.Libs.ZLib.ZStream" /> buffers.
4477
            </summary>
4478
        </member>
4479
        <member name="T:ComponentAce.Compression.Libs.ZLib.ZStreamException">
4480
            <summary>
4481
            Exceptions that occur in ZStream
4482
            </summary>
4483
        </member>
4484
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStreamException.#ctor">
4485
            <summary>
4486
            Default constructor.
4487
            </summary>
4488
        </member>
4489
        <member name="M:ComponentAce.Compression.Libs.ZLib.ZStreamException.#ctor(System.String)">
4490
            <summary>
4491
            Constructor which takes one parameter - an error message
4492
            </summary>
4493
        </member>
4494
    </members>
4495
</doc>