Decompressor Decompressor Decompressor Decompressor Class

Definition

A decompressor takes a stream compressed by a compressor and decompresses it.

public : sealed class Decompressor : IClosable, IDecompressor, IInputStream
public sealed class Decompressor : IDisposable, IDecompressor, IInputStream
Public NotInheritable Class Decompressor Implements IDisposable, IDecompressor, IInputStream
var decompressor = new decompressor(underlyingStream);
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Constructors

Decompressor(IInputStream) Decompressor(IInputStream) Decompressor(IInputStream) Decompressor(IInputStream)

This method creates an instance of a decompressor.

public : Decompressor(IInputStream underlyingStream)
public Decompressor(IInputStream underlyingStream)
Public Sub New(underlyingStream As IInputStream)
var decompressor = new decompressor(underlyingStream);
Parameters
underlyingStream
IInputStream IInputStream IInputStream IInputStream

The stream of compressed information to be read and decompressed by the decompressor.

Methods

Close() Close() Close() Close()

Closes a Decompressor object and synchronously discards any information in buffers. This will close the underlying stream as well unless the Decompressor.Detach method has been used to detach the stream from the object. Subsequent calls on a closed object, except , will fail.

public : void Close()
This member is not implemented in C#
This member is not implemented in VB.Net
decompressor.close();

DetachStream() DetachStream() DetachStream() DetachStream()

Detaches the underlying stream from the Decompressor object so that the object can be closed using the Decompressor.Close method without also closing the underlying stream.

public : IInputStream DetachStream()
public IInputStream DetachStream()
Public Function DetachStream() As IInputStream
var iInputStream = decompressor.detachStream();
Returns

The stream of information.

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++
void Dispose()
Sub Dispose
void Dispose()

ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions)

Reads from the compression stream asynchronously.

public : IAsyncOperationWithProgress<IBuffer, unsigned int> ReadAsync(IBuffer buffer, unsigned int count, InputStreamOptions options)
public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)
Public Function ReadAsync(buffer As IBuffer, count As UInt32, options As InputStreamOptions) As IAsyncOperationWithProgress( Of IBuffer )( Of uint )
Windows.Storage.Compression.Decompressor.readAsync(buffer, count, options).done( /* Your success and error handlers */ );
Parameters
buffer
IBuffer IBuffer IBuffer IBuffer

The buffer that contains the information to be read from the stream.

count
unsigned int UInt32 UInt32 UInt32

The number of bytes to read.

Returns

See Also