CargoStream Class

Microsoft Deployment Compression & Installer

Copy image CopyHover image
Deployment Tools Foundation CargoStream Class
Deployment Tools Foundation NamespacesMicrosoft.Deployment.CompressionCargoStream
Wraps a source stream and carries additional items that are disposed when the stream is closed.
Declaration Syntax
C# Visual Basic Visual C++
public class CargoStream : Stream
Public Class CargoStream
	Inherits Stream
public ref class CargoStream : public Stream
Members
All Members Constructors Methods Properties



Icon Member Description
CargoStream(Stream, array<IDisposable>[]()[][])
Creates a new a cargo stream.

BeginRead(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) HostProtectionAttribute.
Begins an asynchronous read operation.
(Inherited from Stream.)
BeginWrite(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) HostProtectionAttribute.
Begins an asynchronous write operation.
(Inherited from Stream.)
CanRead
Gets a value indicating whether the source stream supports reading.
(Overrides Stream.CanRead.)
CanSeek
Gets a value indicating whether the source stream supports seeking.
(Overrides Stream.CanSeek.)
CanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from Stream.)
CanWrite
Gets a value indicating whether the source stream supports writing.
(Overrides Stream.CanWrite.)
Cargo
Gets the list of additional items that are disposed when the stream is closed. The order of the list is the order in which the items are disposed. The contents can be modified any time.

Close()()()()
Closes the source stream and also closes the additional objects that are carried.
(Overrides Stream.Close()()()().)
CopyTo(Stream)
Reads the bytes from the current stream and writes them to the destination stream.
(Inherited from Stream.)
CopyTo(Stream, Int32)
Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size.
(Inherited from Stream.)
CreateObjRef(Type)
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
CreateWaitHandle()()()() Obsolete.
Allocates a WaitHandle object.
(Inherited from Stream.)
Dispose()()()()
Releases all resources used by the Stream.
(Inherited from Stream.)
Dispose(Boolean)
Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
(Inherited from Stream.)
EndRead(IAsyncResult)
Waits for the pending asynchronous read to complete.
(Inherited from Stream.)
EndWrite(IAsyncResult)
Ends an asynchronous write operation.
(Inherited from Stream.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Flush()()()()
Flushes the source stream.
(Overrides Stream.Flush()()()().)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetLifetimeService()()()()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
InitializeLifetimeService()()()()
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Length
Gets the length of the source stream.
(Overrides Stream.Length.)
MemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
ObjectInvariant()()()()
Provides support for a Contract.
(Inherited from Stream.)
Position
Gets or sets the position of the source stream.
(Overrides Stream.Position.)
Read(array<Byte>[]()[][], Int32, Int32)
Reads from the source stream.
(Overrides Stream.Read(array<Byte>[]()[][], Int32, Int32).)
ReadByte()()()()
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
(Inherited from Stream.)
ReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream.)
Seek(Int64, SeekOrigin)
Changes the position of the source stream.
(Overrides Stream.Seek(Int64, SeekOrigin).)
SetLength(Int64)
Sets the length of the source stream.
(Overrides Stream.SetLength(Int64).)
Source
Gets the source stream of the cargo stream.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Write(array<Byte>[]()[][], Int32, Int32)
Writes to the source stream.
(Overrides Stream.Write(array<Byte>[]()[][], Int32, Int32).)
WriteByte(Byte)
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream.)
WriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream.)
Inheritance Hierarchy
Object
MarshalByRefObject
  Stream
    CargoStream

Assembly: Microsoft.Deployment.Compression (Module: Microsoft.Deployment.Compression.dll) Version: 3.0.0.0 (3.9.1006.0)