public System.Net.Sockets.NetworkStream(System.Net.Sockets.Socket socket, System.IO.FileAccess access, System.Boolean ownsSocket)

Constructs and initializes a new instance of the System.Net.Sockets.NetworkStream class.

Parameter socket: An instance of the System.Net.Sockets.Socket class.

Parameter access: One of the values of the System.IO.FileAccess enumeration.

Parameter ownsSocket: true if socket is owned by the current instance; otherwise, false.

Throws: : socket is null.

Throws: : The System.Net.Sockets.Socket.Blocking property of socket is false. -or- The System.Net.Sockets.Socket.Connected property of socket is false. -or- The System.Net.Sockets.Socket.SocketType property of socket is not System.Net.Sockets.SocketType.Stream.

socket is required to be an instance of the System.Net.Sockets.Socket class with its System.Net.Sockets.Socket.Connected property equal to true , System.Net.Sockets.Socket.Blocking property equal to true , and System.Net.Sockets.SocketType equal to System.Net.Sockets.SocketType.Stream. When ownsSocket is true, the current instance owns socket, meaning the System.Net.Sockets.NetworkStream.Close and System.Net.Sockets.NetworkStream.Dispose(System.Boolean) methods call the System.Net.Sockets.Socket.Close method of socket.

public System.Net.Sockets.NetworkStream(System.Net.Sockets.Socket socket, System.IO.FileAccess access)

Constructs and initializes a new instance of the System.Net.Sockets.NetworkStream class.

Parameter socket: An instance of the System.Net.Sockets.Socket class.

Parameter access: One of the values of the System.IO.FileAccess enumeration.

Throws: : socket is null.

Throws: : The System.Net.Sockets.Socket.Blocking property of socket is false. -or- The System.Net.Sockets.Socket.Connected property of socket is false. -or- The System.Net.Sockets.Socket.SocketType property of socket is not System.Net.Sockets.SocketType.Stream.

This constructor is equivalent to System.Net.Sockets.NetworkStream.NetworkStream(socket, access, false).

public System.Net.Sockets.NetworkStream(System.Net.Sockets.Socket socket)

Constructs and initializes a new instance of the System.Net.Sockets.NetworkStream class.

Parameter socket: An instance of the System.Net.Sockets.Socket class.

Throws: : socket is null.

Throws: : The System.Net.Sockets.Socket.Blocking property of socket is false. -or- The System.Net.Sockets.Socket.Connected property of socket is false. -or- The System.Net.Sockets.Socket.SocketType property of socket is not System.Net.Sockets.SocketType.Stream.

This constructor is equivalent to System.Net.Sockets.NetworkStream.NetworkStream(socket, System.IO.FileAccess.ReadWrite, false).

public System.Net.Sockets.NetworkStream(System.Net.Sockets.Socket socket, System.Boolean ownsSocket)

Constructs and initializes a new instance of the System.Net.Sockets.NetworkStream class.

Parameter socket: An instance of the System.Net.Sockets.Socket class.

Parameter ownsSocket: true if socket is owned by the current instance; otherwise, false.

Throws: : socket is null.

Throws: : The System.Net.Sockets.Socket.Blocking property of socket is false. -or- The System.Net.Sockets.Socket.Connected property of socket is false. -or- The System.Net.Sockets.Socket.SocketType property of socket is not System.Net.Sockets.SocketType.Stream.

This constructor is equivalent to System.Net.Sockets.NetworkStream.NetworkStream(socket, System.IO.FileAccess.ReadWrite, ownsSocket).

public System.IAsyncResult BeginRead(System.Byte[] buffer, System.Int32 offset, System.Int32 size, System.AsyncCallback callback, System.Object state)

Begins an asynchronous operation to read data from the current instance.

Parameter buffer: A System.Byte array to store data read from the stream.

Parameter offset: A System.Int32 containing the zero-based position in buffer at which to begin storing the data.

Parameter size: A System.Int32 containing the number of bytes to read.

Parameter callback: A System.AsyncCallback delegate, or null.

Parameter state: An application-defined object, or null.

Returns: A System.IAsyncResult instance that contains information about the asynchronous operation.

Throws: : buffer is null.

Throws: : offset < 0. -or- offset > buffer.Length. -or- size < 0. -or- size > buffer.Length - offset.

Throws: : An error occurred while accessing the underlying socket. Any exception thrown by the System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object) method is caught and rethrown as an IOException with the original exception stored in the System.Exception.InnerException property.

Throws: : The current instance has been disposed.

To retrieve the results of the operation and release resources allocated by the System.Net.Sockets.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method, call the System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult) method, and specify the System.IAsyncResult object returned by this method. The System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult) method should be called exactly once for each call to the System.Net.Sockets.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method. If the callback parameter is not null, the method referenced by callback is invoked when the asynchronous operation completes. The System.IAsyncResult object returned by this method is passed as the argument to the method referenced by callback. The method referenced by callback can retrieve the results of the operation by calling the System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult) method. The state parameter can be any object that the caller wishes to have available for the duration of the asynchronous operation. This object is available via the System.IAsyncResult.AsyncState property of the object returned by this method. This method overrides System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object).

public System.IAsyncResult BeginWrite(System.Byte[] buffer, System.Int32 offset, System.Int32 size, System.AsyncCallback callback, System.Object state)

Begins an asynchronous operation to write data to the current instance.

Parameter buffer: A System.Byte array containing data to write to the stream.

Parameter offset: A System.Int32 containing the zero-based position in buffer containing the starting location of the data to write.

Parameter size: A System.Int32 containing the number of bytes to write to the stream.

Parameter callback: A System.AsyncCallback delegate, or null.

Parameter state: An application-defined object, or null.

Returns: A System.IAsyncResult instance that contains information about the asynchronous operation.

Throws: : buffer is null.

Throws: : offset < 0. -or- offset > buffer.Length. -or- size < 0. -or- size > buffer.Length - offset.

Throws: : An error occurred while accessing the underlying socket. Any exception thrown by the System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object) method is caught and rethrown as an IOException with the original exception stored in the System.Exception.InnerException property.

Throws: : The current instance has been disposed.

To release resources allocated by the System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method, call the System.Net.Sockets.NetworkStream.EndWrite(System.IAsyncResult) method, and specify the System.IAsyncResult object returned by this method. The System.Net.Sockets.NetworkStream.EndWrite(System.IAsyncResult) method should be called exactly once for each call to the System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method. If the callback parameter is not null, the method referenced by callback is invoked when the asynchronous operation completes. The System.IAsyncResult object returned by this method is passed as the argument to the method referenced by callback. The method referenced by callback can retrieve the results of the operation by calling the System.Net.Sockets.NetworkStream.EndWrite(System.IAsyncResult) method. The state parameter can be any object that the caller wishes to have available for the duration of the asynchronous operation. This object is available via the System.IAsyncResult.AsyncState property of the object returned by this method. This method overrides System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object).

public System.Void Close()

Closes the stream and, if owned by the current instance, the underlying socket.

This method calls System.Net.Sockets.NetworkStream.Dispose(System.Boolean)(true ), which frees both managed and unmanaged resources used by the current instance. When the underlying socket is owned by the current instance, the System.Net.Sockets.Socket.Close method of the socket is called, which frees both managed and unmanaged resources used by the socket. Ownership of a socket is specified using the System.Net.Sockets.NetworkStream constructor. This method overrides System.IO.Stream.Close.

protected virtual System.Void Dispose(System.Boolean disposing)

Releases the unmanaged resources used by the current instance and optionally releases the managed resources.

Parameter disposing: A System.Boolean. Specify true to release both managed and unmanaged resources; specify false to release only unmanaged resources.

Ownership of a socket is specified using the System.Net.Sockets.NetworkStream constructor. The System.Net.Sockets.NetworkStream.Close method calls this method with the disposing parameter set to true. The finalizer calls this method with the disposing parameter set to false. This method closes the current System.Net.Sockets.NetworkStream instance releasing all unmanaged resources allocated by the current instance. When the underlying socket is owned by the current instance, the System.Net.Sockets.Socket.Close method of the socket is called, which frees the managed and unmanaged resources used by the socket. When the disposing parameter is true , this method also releases all resources held by any other managed objects allocated by the current instance. This method closes the current System.Net.Sockets.NetworkStream instance releasing all unmanaged resources allocated by the current instance. When the underlying socket is owned by the current instance, the System.Net.Sockets.Socket.Close method of the socket is called, which frees the managed and unmanaged resources used by the socket. The System.Net.Sockets.Socket.Dispose(System.Boolean) method can be called multiple times by other objects. When overriding this method, do not reference objects that have been previously disposed in an earlier call. Use this method to release resources allocated by the current instance.

public System.Int32 EndRead(System.IAsyncResult asyncResult)

Ends an asynchronous call to read data from the current instance.

Parameter asyncResult: A System.IAsyncResult object that holds the state information for the asynchronous operation.

Returns: A System.Int32 containing the number of bytes read from the stream.

Throws: : asyncResult is null.

Throws: : An error occurred while accessing the underlying socket. This method catches all exceptions thrown by the System.Net.Sockets.Socket.EndReceive(System.IAsyncResult) method.

Throws: : The current instance has been disposed.

This method blocks if the asynchronous operation has not completed. The System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult) method completes an asynchronous request that was started with a call to the System.Net.Sockets.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method. The object specified for the asyncResult parameter is required to be the same object as was returned by the System.Net.Sockets.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method call that began the request. If the System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult) method is invoked via the System.AsyncCallback delegate specified to the System.Net.Sockets.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method, the asyncResult parameter is the System.IAsyncResult argument passed to the delegate's method. This method overrides System.IO.Stream.EndRead(System.IAsyncResult).

public System.Void EndWrite(System.IAsyncResult asyncResult)

Ends an asynchronous call to write data to the current instance.

Parameter asyncResult: A System.IAsyncResult object that holds the state information for the asynchronous operation.

Throws: : asyncResult is null.

Throws: : An error occurred while accessing the underlying socket. This method catches all exceptions thrown by the System.Net.Sockets.Socket.EndSend(System.IAsyncResult) method.

Throws: : The current instance has been disposed.

This method blocks if the asynchronous operation has not completed. The System.Net.Sockets.NetworkStream.EndWrite(System.IAsyncResult) method completes an asynchronous request that was started with a call to the System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method. The object specified for the asyncResult parameter is required to be the same object as was returned by the System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method call that began the request. If the System.Net.Sockets.NetworkStream.EndWrite(System.IAsyncResult) method is invoked via the System.AsyncCallback delegate specified to the System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method, the asyncResult parameter is the System.IAsyncResult argument passed to the delegate's method. This method overrides System.IO.Stream.EndWrite(System.IAsyncResult).

public System.Void Finalize()

Frees unmanaged resources used by the current instance.

Application code does not call this method; it is automatically invoked during garbage collection unless finalization by the garbage collector has been disabled. For more information, see System.GC.SuppressFinalize(System.Object), and System.Object.Finalize. This method calls System.Net.Sockets.NetworkStream.Dispose(System.Boolean)(false), which frees unmanaged resources used by the current instance. When the underlying socket is owned by the current instance, it is closed and the managed and unmanaged resources used by the socket are freed. Ownership of a socket is specified using the System.Net.Sockets.NetworkStream constructor. This method overrides System.Object.Finalize.

public System.Void Flush()

This method is reserved for future use.

Calling this method does not throw an exception. This method overrides System.IO.Stream.Flush.

public System.Int32 Read(System.Byte[] buffer, System.Int32 offset, System.Int32 size)

Reads data from the current instance and stores it in a data buffer.

Parameter buffer: A System.Byte array to store data read from the stream.

Parameter offset: A System.Int32 containing the zero-based position in buffer at which to begin storing the data.

Parameter size: A System.Int32 containing the number of bytes to read.

Returns: A System.Int32 containing the number of bytes read from the stream.

Throws: : buffer is null.

Throws: : offset < 0. -or- offset > buffer.Length. -or- size < 0. -or- size > buffer.Length - offset.

Throws: : An error occurred while accessing the underlying socket. This method catches all exceptions thrown by the System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags) method.

Throws: : The current instance has been disposed.

When no incoming data is available, this method blocks and waits for data to arrive. If the remote socket was shut down gracefully (System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown) was called on the socket or the System.Net.Sockets.SocketOptionName.Linger option was enabled and System.Net.Sockets.Socket.Close was called on the socket) and all data was received, this method immediately returns zero. This method overrides System.IO.Stream.Read(System.Byte[],System.Int32,System.Int32).

public System.Int64 Seek(System.Int64 offset, System.IO.SeekOrigin origin)

Throws a System.NotSupportedException.

Parameter offset: This parameter is not used.

Parameter origin: This parameter is not used.

Throws: : Any call to this method.

The System.IO.Stream base class uses this method to set the current position in the stream. This functionality is not supported in the System.Net.Sockets.NetworkStream class. This method overrides System.IO.Stream.Seek(System.Int64,System.IO.SeekOrigin).

public System.Void SetLength(System.Int64 value)

Throws a System.NotSupportedException.

Parameter value: This parameter is not used.

Throws: : Any call to this method.

The System.IO.Stream base class uses this method to set the length of the data available on the stream. This functionality is not supported in the System.Net.Sockets.NetworkStream class. This method overrides System.IO.Stream.SetLength(System.Int64).

public System.Void Write(System.Byte[] buffer, System.Int32 offset, System.Int32 size)

Writes data from a specific area of a data buffer to the current instance.

Parameter buffer: A System.Byte array containing data to write to the stream.

Parameter offset: A System.Int32 containing the zero-based position in buffer containing the starting location of the data to write.

Parameter size: A System.Int32 containing the number of bytes to write to the stream.

Throws: : buffer is null.

Throws: : offset < 0. -or- offset > buffer.Length. -or- size < 0. -or- size > buffer.Length - offset.

Throws: : An error occurred while accessing the underlying socket. This method catches all exceptions thrown by the System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags) method.

Throws: : The current instance has been disposed.

When no buffer space is available within the underlying protocol, this method blocks unless the socket is in non-blocking mode. This method overrides System.IO.Stream.Write(System.Byte[],System.Int32,System.Int32).

public virtual System.IAsyncResult BeginRead(System.Byte[] buffer, System.Int32 offset, System.Int32 count, System.AsyncCallback callback, System.Object state)

Begins an asynchronous read operation.

Parameter buffer: The System.Byte array to read the data into.

Parameter offset: A System.Int32 that specifies the byte offset in buffer at which to begin writing data read from the stream.

Parameter count: A System.Int32 that specifies the maximum number of bytes to read from the stream.

Parameter callback: A System.AsyncCallback delegate to be called when the read is complete, or null.

Parameter state: An application-defined object, or null.

Returns: A System.IAsyncResult that contains information about the asynchronous read operation, which could still be pending.

Throws: : An I/O error occurred.

Throws: : The current System.IO.Stream does not support reading.

This method starts an asynchronous read operation. To determine how many bytes were read and release resources allocated by this method, call the System.IO.Stream.EndRead(System.IAsyncResult) method and specify the System.IAsyncResult object returned by this method. The System.IO.Stream.EndRead(System.IAsyncResult) method should be called exactly once for each call to System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object). If the callback parameter is not null, the method referenced by callback is invoked when the asynchronous operation completes. The System.IAsyncResult object returned by this method is passed as the argument to the method referenced by callback. The current position in the stream is updated when the asynchronous read or write is issued, not when the I/O operation completes. Multiple simultaneous asynchronous requests render the request completion order uncertain. The state parameter can be any object that the caller wishes to have available for the duration of the asynchronous operation. This object is available via the System.IAsyncResult.AsyncState property of the object returned by this method. Use the System.IO.Stream.CanRead property to determine whether the current instance supports reading. As described above.

public virtual System.IAsyncResult BeginWrite(System.Byte[] buffer, System.Int32 offset, System.Int32 count, System.AsyncCallback callback, System.Object state)

Begins an asynchronous write operation.

Parameter buffer: The System.Byte array to be written to the current stream.

Parameter offset: A System.Int32 that specifies the byte offset in buffer at which to begin copying bytes to the current stream.

Parameter count: A System.Int32 that specifies the maximum number of bytes to be written to the current stream.

Parameter callback: A System.AsyncCallback delegate to be called when the write is complete, or null.

Parameter state: An application-defined object, or null.

Returns: A System.IAsyncResult that represents the asynchronous write, which could still be pending.

Throws: : The current System.IO.Stream does not support writing.

Throws: : An I/O error occurred.

Pass the System.IAsyncResult returned by this method to System.IO.Stream.EndWrite(System.IAsyncResult) to ensure that the write completes and frees resources appropriately. If an error occurs during an asynchronous write, an exception will not be thrown until System.IO.Stream.EndWrite(System.IAsyncResult) is called with the System.IAsyncResult returned by this method. If a failure is detected from the underlying OS (such as if a floppy is ejected in the middle of the operation), the results of the write operation are undefined. If the callback parameter is not null, the method referenced by callback is invoked when the asynchronous operation completes. The System.IAsyncResult object returned by this method is passed as the argument to the method referenced by callback. The state parameter can be any object that the caller wishes to have available for the duration of the asynchronous operation. This object is available via the System.IAsyncResult.AsyncState property of the object returned by this method. If a stream is writable, writing at the end of it expands the stream. The current position in the stream is updated when you issue the asynchronous read or write, not when the I/O operation completes. Multiple simultaneous asynchronous requests render the request completion order uncertain. buffer should generally be greater than 64 KB. Use the System.IO.Stream.CanWrite property to determine whether the current instance supports writing. As described above.

public virtual System.Void Close()

Closes the current stream and releases any resources associated with the current stream.

Following a call to this method, other operations on the stream might throw exceptions. If the stream is already closed, a call to System.IO.Stream.Close throws no exceptions. If this method is called while an asynchronous read or write is pending for a stream, the behavior of the stream is undefined. As described above.

protected virtual System.Threading.WaitHandle CreateWaitHandle()

Allocates a System.Threading.WaitHandle object.

Returns: A reference to the allocated System.Threading.WaitHandle.

When called for the first time this method creates a System.Threading.WaitHandle object and returns it. On subsequent calls, the System.IO.Stream.CreateWaitHandle method returns a reference to the same wait handle. System.IO.Stream.CreateWaitHandle is useful if you implement the asynchronous methods and require a way of blocking in System.IO.Stream.EndRead(System.IAsyncResult) or System.IO.Stream.EndWrite(System.IAsyncResult) until the asynchronous operation is complete.

public virtual System.Int32 EndRead(System.IAsyncResult asyncResult)

Ends a pending asynchronous read request.

Parameter asyncResult: The System.IAsyncResult object that references the pending asynchronous read request.

Returns: A System.Int32 that indicates the number of bytes read from the stream, between 0 and the number of bytes specified via the System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) count parameter. Streams only return 0 at the end of the stream, otherwise, they block until at least 1 byte is available.

Throws: : asyncResult is null.

Throws: : asyncResult did not originate from a System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method on the current stream.

System.IO.Stream.EndRead(System.IAsyncResult) blocks until the I/O operation has completed. As described above.

public virtual System.Void EndWrite(System.IAsyncResult asyncResult)

Ends an asynchronous write operation.

Parameter asyncResult: A System.IAsyncResult that references the outstanding asynchronous I/O request.

Throws: : The asyncResult parameter is null.

Throws: : asyncResult did not originate from a System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method on the current stream.

System.IO.Stream.EndWrite(System.IAsyncResult) is required to be called exactly once for every System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object). System.IO.Stream.EndWrite(System.IAsyncResult) blocks until the write I/O operation has completed. As described above.

public System.Void Flush()

Flushes the internal buffer.

Throws: : An I/O error occurs, such as the file being already closed.

Implementers should use this method to move any information from an underlying buffer to its destination. The System.IO.Stream.Flush method should clear the buffer, but the stream should not be closed. Depending upon the state of the object, the current position within the stream might need to be modified (for example, if the underlying stream supports seeking). For additional information see System.IO.Stream.CanSeek . As described above. Override System.IO.Stream.Flush on streams that implement a buffer.

public System.Int32 Read(System.Byte[] buffer, System.Int32 offset, System.Int32 count)

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Parameter buffer: A System.Byte array. When this method returns, the elements between offset and (offset + count - 1) are replaced by the bytes read from the current source.

Parameter offset: A System.Int32 that specifies the zero based byte offset in buffer at which to begin storing the data read from the current stream.

Parameter count: A System.Int32 that specifies the maximum number of bytes to be read from the current stream.

Returns: A System.Int32 that specifies the total number of bytes read into the buffer, or zero if the end of the stream has been reached before any data can be read.

Throws: : (offset + count - 1) is greater than the length of buffer.

Throws: : buffer is null.

Throws: : offset or count is less than zero.

Throws: : An I/O error occurred.

Throws: : The current stream does not support reading.

Use the System.IO.Stream.CanRead property to determine whether the current instance supports reading. As described above.

public virtual System.Int32 ReadByte()

Reads a byte from the stream and advances the position within the stream by one byte.

Returns: The unsigned byte cast to a System.Int32 , or -1 if at the end of the stream.

Throws: : The stream does not support reading.

Throws: : The stream is closed.

Throws: : An I/O error has occurred.

As described above. Use the System.IO.Stream.CanRead property to determine whether the current instance supports reading.

public System.Int64 Seek(System.Int64 offset, System.IO.SeekOrigin origin)

Sets the position within the current stream.

Parameter offset: A System.Int64 that specifies the byte offset relative to origin.

Parameter origin: A System.IO.SeekOrigin value indicating the reference point used to obtain the new position.

Returns: A System.Int64 that specifies the new position within the current stream.

Throws: : The stream does not support seeking, such as if the stream is constructed from a pipe or console output.

Throws: : The current System.IO.Stream is closed.

Throws: : An I/O error has occurred.

Use the System.IO.Stream.CanSeek property to determine whether the current instance supports seeking. If offset is negative, the new position is required to precede the position specified by origin by the number of bytes specified by offset. If offset is zero, the new position is required to be the position specified by origin. If offset is positive, the new position is required to follow the position specified by origin by the number of bytes specified by offset. If you intend to use a file as a backing store for a stream implementation, you are required to override System.IO.Stream.Seek(System.Int64,System.IO.SeekOrigin) to set the System.IO.Stream.Position property one byte beyond the end of the stream. The position cannot be set to more than one byte beyond the end of the stream. Classes derived from System.IO.Stream that support seeking are required to override this method.

public System.Void SetLength(System.Int64 value)

Sets the length of the current stream.

Parameter value: A System.Int64 that specifies the desired length of the current stream in bytes.

Throws: : The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.

Throws: : The current System.IO.Stream is closed.

Throws: : An I/O error occurred.

Use the System.IO.Stream.CanWrite property to determine whether the current instance supports writing, and the System.IO.Stream.CanSeek property to determine whether seeking is supported. If the specified value is less than the current length of the stream, the stream is truncated. If the specified value is larger than the current length of the stream, the stream is expanded. If the stream is expanded, the contents of the stream between the old and the new length are initialized to zeros. There is no default implementation. Classes derived from System.IO.Stream are required to support both writing and seeking for System.IO.Stream.SetLength(System.Int64) to work.

public System.Void System.IDisposable.Dispose()

Implemented to support the System.IDisposable interface. [Note: For more information, see System.IDisposable.Dispose.]

public System.Void Write(System.Byte[] buffer, System.Int32 offset, System.Int32 count)

Writes a sequence of bytes to the current stream and advances the current position within the current stream by the number of bytes written.

Parameter buffer: A System.Byte array containing the data to write.

Parameter offset: A System.Int32 that specifies the zero based byte offset in buffer at which to begin copying bytes to the current stream.

Parameter count: A System.Int32 that specifies the number of bytes to be written to the current stream.

Throws: : (offset + count ) is greater than the length of buffer.

Throws: : buffer is null.

Throws: : offset or count is negative.

Throws: : An I/O error occurred.

Throws: : The stream does not support writing.

Use the System.IO.Stream.CanWrite property to determine whether the current instance supports writing. If the write operation is successful, the position within the stream advances by the number of bytes written. If an exception occurs, the position within the stream remains unchanged.

public virtual System.Void WriteByte(System.Byte value)

Writes a System.Byte to the current position in the stream and advances the position within the stream by one byte.

Parameter value: The System.Byte to write to the stream.

Throws: : The stream does not support writing.

Throws: : The stream is closed.

Throws: : An I/O error has occurred.

Use the System.IO.Stream.CanWrite property to determine whether the current instance supports writing. As described above.

public virtual System.Boolean Equals(System.Object obj)

Determines whether the specified System.Object is equal to the current instance.

Parameter obj: The System.Object to compare with the current instance.

Returns: true if obj is equal to the current instance; otherwise, false.

The statements listed below are required to be true for all implementations of the System.Object.Equals(System.Object) method. In the list, x, y, and z represent non-null object references. See System.Object.GetHashCode for additional required behaviors pertaining to the System.Object.Equals(System.Object) method. Implementations of System.Object.Equals(System.Object) should not throw exceptions. The System.Object.Equals(System.Object) method tests for referential equality , which means that System.Object.Equals(System.Object) returns true if the specified instance of Object and the current instance are the same instance; otherwise, it returns false . An implementation of the System.Object.Equals(System.Object) method is shown in the following C# code: public virtual bool Equals(Object obj) { return this == obj; } For some kinds of objects, it is desirable to have System.Object.Equals(System.Object) test for value equality instead of referential equality. Such implementations of Equals return true if the two objects have the same "value", even if they are not the same instance. The definition of what constitutes an object's "value" is up to the implementer of the type, but it is typically some or all of the data stored in the instance variables of the object. For example, the value of a System.String is based on the characters of the string; the Equals method of the System.String class returns true for any two string instances that contain exactly the same characters in the same order. When the Equals method of a base class provides value equality, an override of Equals in a class derived from that base class should invoke the inherited implementation of Equals . It is recommended (but not required) that types overriding System.Object.Equals(System.Object) also override System.Object.GetHashCode. Hashtables cannot be relied on to work correctly if this recommendation is not followed. If your programming language supports operator overloading, and if you choose to overload the equality operator for a given type, that type should override the Equals method. Such implementations of the Equals method should return the same results as the equality operator. Following this guideline will help ensure that class library code using Equals (such as System.Collections.ArrayList and System.Collections.Hashtable ) behaves in a manner that is consistent with the way the equality operator is used by application code. If you are implementing a value type, you should follow these guidelines: For reference types, the guidelines are as follows: If you implement System.IComparable on a given type, you should override Equals on that type. The System.Object.Equals(System.Object) method is called by methods in collections classes that perform search operations, including the System.Array.IndexOf(System.Array,System.Object) method and the System.Collections.ArrayList.Contains(System.Object) method.

using System;
class MyClass {
   static void Main() {
      Object obj1 = new Object();
      Object obj2 = new Object();
      Console.WriteLine(obj1.Equals(obj2));
      obj1 = obj2; 
      Console.WriteLine(obj1.Equals(obj2)); 
   }
}

using System;
public class Point: object {
 int x, y;
 public override bool Equals(Object obj) {
 //Check for null and compare run-time types.
 if (obj == null || GetType() != obj.GetType()) return false;
 Point p = (Point)obj;
 return (x == p.x) && (y == p.y);
 }
 public override int GetHashCode() {
 return x ^ y;
 }
}

class Point3D: Point {
 int z;
 public override bool Equals(Object obj) {
 return base.Equals(obj) && z == ((Point3D)obj).z;
 }
 public override int GetHashCode() {
 return base.GetHashCode() ^ z;
 }
}

using System;
class Rectangle {
 Point a, b;
 public override bool Equals(Object obj) {
 if (obj == null || GetType() != obj.GetType()) return false;
 Rectangle r = (Rectangle)obj;
 //Use Equals to compare instance variables
 return a.Equals(r.a) && b.Equals(r.b);
 }
 public override int GetHashCode() {
 return a.GetHashCode() ^ b.GetHashCode();
 }
}

using System;
public struct Complex {
 double re, im;
 public override bool Equals(Object obj) {
 return obj is Complex && this == (Complex)obj;
 }
 public override int GetHashCode() {
 return re.GetHashCode() ^ im.GetHashCode();
 }
 public static bool operator ==(Complex x, Complex y) {
 return x.re == y.re && x.im == y.im;
 }
 public static bool operator !=(Complex x, Complex y) {
 return !(x == y);
 }
}

public static System.Boolean Equals(System.Object objA, System.Object objB)

Determines whether two object references are equal.

Parameter objA: First object to compare.

Parameter objB: Second object to compare.

Returns: true if one or more of the following statements is true: otherwise returns false.

This static method checks for null references before it calls objA.Equals(objB ) and returns false if either objA or objB is null. If the Equals(object obj) implementation throws an exception, this method throws an exception.

using System;

public class MyClass {
   public static void Main() {
   string s1 = "Tom";
   string s2 = "Carol";
   Console.WriteLine("Object.Equals(\"{0}\", \"{1}\") => {2}", 
      s1, s2, Object.Equals(s1, s2));

   s1 = "Tom";
   s2 = "Tom";
   Console.WriteLine("Object.Equals(\"{0}\", \"{1}\") => {2}", 
      s1, s2, Object.Equals(s1, s2));

   s1 = null;
   s2 = "Tom";
   Console.WriteLine("Object.Equals(null, \"{1}\") => {2}",
       s1, s2, Object.Equals(s1, s2));

   s1 = "Carol";
   s2 = null;
   Console.WriteLine("Object.Equals(\"{0}\", null) => {2}", 
       s1, s2, Object.Equals(s1, s2));

   s1 = null;
   s2 = null;
   Console.WriteLine("Object.Equals(null, null) => {2}", 
       s1, s2, Object.Equals(s1, s2));
   }
}
   

public System.Void Finalize()

Allows a System.Object to perform cleanup operations before the memory allocated for the System.Object is automatically reclaimed.

During execution, System.Object.Finalize is automatically called after an object becomes inaccessible, unless the object has been exempted from finalization by a call to System.GC.SuppressFinalize(System.Object). During shutdown of an application domain, System.Object.Finalize is automatically called on objects that are not exempt from finalization, even those that are still accessible. System.Object.Finalize is automatically called only once on a given instance, unless the object is re-registered using a mechanism such as System.GC.ReRegisterForFinalize(System.Object) and System.GC.SuppressFinalize(System.Object) has not been subsequently called. Conforming implementations of the CLI are required to make every effort to ensure that for every object that has not been exempted from finalization, the System.Object.Finalize method is called after the object becomes inaccessible. However, there may be some circumstances under which Finalize is not called. Conforming CLI implementations are required to explicitly specify the conditions under which Finalize is not guaranteed to be called. For example, Finalize might not be guaranteed to be called in the event of equipment failure, power failure, or other catastrophic system failures. In addition to System.GC.ReRegisterForFinalize(System.Object) and System.GC.SuppressFinalize(System.Object), conforming implementations of the CLI are allowed to provide other mechanisms that affect the behavior of System.Object.Finalize . Any mechanisms provided are required to be specified by the CLI implementation. The order in which the Finalize methods of two objects are run is unspecified, even if one object refers to the other. The thread on which Finalize is run is unspecified. Every implementation of System.Object.Finalize in a derived type is required to call its base type's implementation of Finalize . This is the only case in which application code calls System.Object.Finalize . The System.Object.Finalize implementation does nothing. A type should implement Finalize when it uses unmanaged resources such as file handles or database connections that must be released when the managed object that uses them is reclaimed. Because Finalize methods may be invoked in any order (including from multiple threads), synchronization may be necessary if the Finalize method may interact with other objects, whether accessible or not. Furthermore, since the order in which Finalize is called is unspecified, implementers of Finalize (or of destructors implemented through overriding Finalize) must take care to correctly handle references to other objects, as their Finalize method may already have been invoked. In general, referenced objects should not be considered valid during finalization. See the System.IDisposable interface for an alternate means of disposing of resources. For C# developers: Destructors are the C# mechanism for performing cleanup operations. Destructors provide appropriate safeguards, such as automatically calling the base type's destructor. In C# code, System.Object.Finalize cannot be called or overridden.

public virtual System.Int32 GetHashCode()

Generates a hash code for the current instance.

Returns: A System.Int32 containing the hash code for the current instance.

System.Object.GetHashCode serves as a hash function for a specific type. A hash function is used to quickly generate a number (a hash code) corresponding to the value of an object. Hash functions are used with hashtables. A good hash function algorithm rarely generates hash codes that collide. For more information about hash functions, see The Art of Computer Programming , Vol. 3, by Donald E. Knuth. All implementations of System.Object.GetHashCode are required to ensure that for any two object references x and y, if x.Equals(y) == true, then x.GetHashCode() == y.GetHashCode(). Hash codes generated by System.Object.GetHashCode need not be unique. Implementations of System.Object.GetHashCode are not permitted to throw exceptions. The System.Object.GetHashCode implementation attempts to produce a unique hash code for every object, but the hash codes generated by this method are not guaranteed to be unique. Therefore, System.Object.GetHashCode may generate the same hash code for two different instances. It is recommended (but not required) that types overriding System.Object.GetHashCode also override System.Object.Equals(System.Object) . Hashtables cannot be relied on to work correctly if this recommendation is not followed. Use this method to obtain the hash code of an object. Hash codes should not be persisted (i.e. in a database or file) as they are allowed to change from run to run.

using System;
public struct Int32 {
 int value;
 //other methods...

 public override int GetHashCode() {
 return value;
 }
}

using System;
public struct Point {
 int x;
 int y; 
 //other methods
 
 public override int GetHashCode() {
 return x ^ y;
 }
}

using System;
public class SomeType {
 public override int GetHashCode() {
 return 0;
 }
}

public class AnotherType {
 public override int GetHashCode() {
 return 1;
 }
}

public class LastType {
 public override int GetHashCode() {
 return 2;
 }
}
public class MyClass {
 SomeType a = new SomeType();
 AnotherType b = new AnotherType();
 LastType c = new LastType();

 public override int GetHashCode () {
 return a.GetHashCode() ^ b.GetHashCode() ^ c.GetHashCode();
 }
}

using System;
public struct Int64 {
 long value;
 //other methods...

 public override int GetHashCode() {
 return ((int)value ^ (int)(value >> 32));
 }
}

public System.Type GetType()

Gets the type of the current instance.

Returns: The instance of System.Type that represents the run-time type (the exact type) of the current instance.

For two objects x and y that have identical run-time types, System.Object.ReferenceEquals(System.Object,System.Object)(x.GetType(),y.GetType()) returns true .

using System;
public class MyBaseClass: Object {
}
public class MyDerivedClass: MyBaseClass {
}
public class Test {
   public static void Main() {
   MyBaseClass myBase = new MyBaseClass();
   MyDerivedClass myDerived = new MyDerivedClass();

   object o = myDerived;
   MyBaseClass b = myDerived;

   Console.WriteLine("mybase: Type is {0}", myBase.GetType());
   Console.WriteLine("myDerived: Type is {0}", myDerived.GetType());
   Console.WriteLine("object o = myDerived: Type is {0}", o.GetType());
   Console.WriteLine("MyBaseClass b = myDerived: Type is {0}", b.GetType());
   }
}

protected System.Object MemberwiseClone()

Creates a shallow copy of the current instance.

Returns: A shallow copy of the current instance. The run-time type (the exact type) of the returned object is the same as the run-time type of the object that was copied.

System.Object.MemberwiseClone creates a new instance of the same type as the current instance and then copies each of the object's non-static fields in a manner that depends on whether the field is a value type or a reference type. If the field is a value type, a bit-by-bit copy of all the field's bits is performed. If the field is a reference type, only the reference is copied. The algorithm for performing a shallow copy is as follows (in pseudo-code): for each instance field f in this instance if (f is a value type) bitwise copy the field if (f is a reference type) copy the reference end for loop This mechanism is referred to as a shallow copy because it copies rather than clones the non-static fields. Because System.Object.MemberwiseClone implements the above algorithm, for any object, a, the following statements are required to be true: System.Object.MemberwiseClone does not call any of the type's constructors. If System.Object.Equals(System.Object) has been overridden, a.MemberwiseClone().Equals(a) might return false . For an alternate copying mechanism, see System.ICloneable . System.Object.MemberwiseClone is protected (rather than public) to ensure that from verifiable code it is only possible to clone objects of the same class as the one performing the operation (or one of its subclasses). Although cloning an object does not directly open security holes, it does allow an object to be created without running any of its constructors. Since these constructors may establish important invariants, objects created by cloning may not have these invariants established, and this may lead to incorrect program behavior. For example, a constructor might add the new object to a linked list of all objects of this class, and cloning the object would not add the new object to that list -- thus operations that relied on the list to locate all instances would fail to notice the cloned object. By making the method protected, only objects of the same class (or a subclass) can produce a clone and implementers of those classes are (presumably) aware of the appropriate invariants and can arrange for them to be true without necessarily calling a constructor.

using System;
class MyBaseClass {
   public static string CompanyName = "My Company";
   public int age;
   public string name;
}

class MyDerivedClass: MyBaseClass {

   static void Main() {
   
   //Create an instance of MyDerivedClass
   //and assign values to its fields.
   MyDerivedClass m1 = new MyDerivedClass();
   m1.age = 42;
   m1.name = "Sam";

   //Do a shallow copy of m1
   //and assign it to m2.
   MyDerivedClass m2 = (MyDerivedClass) m1.MemberwiseClone();
   }
}

+---------------+

|     42        |                           m1 

+---------------+

|     +---------|-----------------> "Sam" 

+---------------+                    /|\ 

                                      | 

+---------------+                     | 

|     42        |                     |      m2 

+---------------+                     | 

|      +--------|---------------------| 

+---------------+

public static System.Boolean ReferenceEquals(System.Object objA, System.Object objB)

Determines whether two object references are identical.

Parameter objA: First object to compare.

Parameter objB: Second object to compare.

Returns: True if a and b refer to the same object or are both null references; otherwise, false.

This static method provides a way to compare two objects for reference equality. It does not call any user-defined code, including overrides of System.Object.Equals(System.Object) .

using System;
class MyClass {
   static void Main() {
   object o = null;
   object p = null;
   object q = new Object();
   Console.WriteLine(Object.ReferenceEquals(o, p));
   p = q;
   Console.WriteLine(Object.ReferenceEquals(p, q));
   Console.WriteLine(Object.ReferenceEquals(o, p));
   }
}
   

public virtual System.String ToString()

Creates and returns a System.String representation of the current instance.

Returns: A System.String representation of the current instance.

System.Object.ToString returns a string whose content is intended to be understood by humans. Where the object contains culture-sensitive data, the string representation returned by System.Object.ToString takes into account the current system culture. For example, for an instance of the System.Double class whose value is zero, the implementation of System.Double.ToString might return "0.00" or "0,00" depending on the current UI culture. Although there are no exact requirements for the format of the returned string, it should as much as possible reflect the value of the object as perceived by the user. System.Object.ToString is equivalent to calling System.Object.GetType to obtain the System.Type object for the current instance and then returning the result of calling the System.Object.ToString implementation for that type. The value returned includes the full name of the type. It is recommended, but not required, that System.Object.ToString be overridden in a derived class to return values that are meaningful for that type. For example, the base data types, such as System.Int32, implement System.Object.ToString so that it returns the string form of the value the object represents. Subclasses that require more control over the formatting of strings than System.Object.ToString provides should implement System.IFormattable, whose System.Object.ToString method uses the culture of the current thread.

using System;

class MyClass {
   static void Main() {
      object o = new object();
      Console.WriteLine (o.ToString());
   }
}
      

public System.Void Dispose()

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

This method is, by convention, used for all tasks associated with freeing resources held by an object, or preparing an object for reuse. When implementing the System.IDisposable.Dispose method, objects should seek to ensure that all held resources are freed by propagating the call through the containment hierarchy. For example, if an object A allocates an object B, and B allocates an object C, then A's System.IDisposable.Dispose implementation should call System.IDisposable.Dispose on B, which should in turn call System.IDisposable.Dispose on C. Objects should also call the System.IDisposable.Dispose method of their base class if the base class implements System.IDisposable. If an object's System.IDisposable.Dispose method is called more than once, the object should ignore all calls after the first one. The object should not throw an exception if its System.IDisposable.Dispose method is called multiple times. System.IDisposable.Dispose may throw an exception if an error occurs because a resource has already been freed and System.IDisposable.Dispose had not been called previously. A resource type may use a particular convention to denote an allocated state versus a freed state. An example of this is stream classes, which are traditionally thought of as open or closed. Classes that have such conventions may choose to implement a public method with a customized name, which calls the System.IDisposable.Dispose method. Because the System.IDisposable.Dispose method must be called explicitly, objects that implement System.IDisposable should also implement a finalizer to handle freeing resources when System.IDisposable.Dispose is not called. By default, the garbage collector will automatically call an object's finalizer prior to reclaiming its memory. However, once the System.IDisposable.Dispose method has been called, it is typically unnecessary and/or undesirable for the garbage collector to call the disposed object's finalizer. To prevent automatic finalization, System.IDisposable.Dispose implementations can call System.GC.SuppressFinalize(System.Object). For additional information on implementing finalizers, see System.GC and System.Object.Finalize.

class ResourceWrapper : BaseType, IDisposable {
  // Pointer to a external resource.
  private int handle; 
  private OtherResource otherRes; //Other resource you use.
  private bool disposed = false;

  public ResourceWrapper () {
    handle = //Allocate on the unmanaged side.
    otherRes = new OtherResource (...);
  }
  // Free your own state.
  private void freeState () {
    if (!disposed) {
       CloseHandle (handle);
       dispose = true;
    }
  }

  // Free your own state, call dispose on all state you hold, 
  // and take yourself off the Finalization queue.
  public void Dispose () {
    freeState ();
    OtherRes.Dispose();
    // If base type implements dispose, call it.
    base.Dispose(); 
    GC.SuppressFinalize(this);  
  }

  // Free your own state (not other state you hold) 
  // and give your base class a chance to finalize. 
  ~ResourceWrapper (){
     freeState();
  }
}
   

public System.Void Dispose()

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

This method is, by convention, used for all tasks associated with freeing resources held by an object, or preparing an object for reuse. When implementing the System.IDisposable.Dispose method, objects should seek to ensure that all held resources are freed by propagating the call through the containment hierarchy. For example, if an object A allocates an object B, and B allocates an object C, then A's System.IDisposable.Dispose implementation should call System.IDisposable.Dispose on B, which should in turn call System.IDisposable.Dispose on C. Objects should also call the System.IDisposable.Dispose method of their base class if the base class implements System.IDisposable. If an object's System.IDisposable.Dispose method is called more than once, the object should ignore all calls after the first one. The object should not throw an exception if its System.IDisposable.Dispose method is called multiple times. System.IDisposable.Dispose may throw an exception if an error occurs because a resource has already been freed and System.IDisposable.Dispose had not been called previously. A resource type may use a particular convention to denote an allocated state versus a freed state. An example of this is stream classes, which are traditionally thought of as open or closed. Classes that have such conventions may choose to implement a public method with a customized name, which calls the System.IDisposable.Dispose method. Because the System.IDisposable.Dispose method must be called explicitly, objects that implement System.IDisposable should also implement a finalizer to handle freeing resources when System.IDisposable.Dispose is not called. By default, the garbage collector will automatically call an object's finalizer prior to reclaiming its memory. However, once the System.IDisposable.Dispose method has been called, it is typically unnecessary and/or undesirable for the garbage collector to call the disposed object's finalizer. To prevent automatic finalization, System.IDisposable.Dispose implementations can call System.GC.SuppressFinalize(System.Object). For additional information on implementing finalizers, see System.GC and System.Object.Finalize.

class ResourceWrapper : BaseType, IDisposable {
  // Pointer to a external resource.
  private int handle; 
  private OtherResource otherRes; //Other resource you use.
  private bool disposed = false;

  public ResourceWrapper () {
    handle = //Allocate on the unmanaged side.
    otherRes = new OtherResource (...);
  }
  // Free your own state.
  private void freeState () {
    if (!disposed) {
       CloseHandle (handle);
       dispose = true;
    }
  }

  // Free your own state, call dispose on all state you hold, 
  // and take yourself off the Finalization queue.
  public void Dispose () {
    freeState ();
    OtherRes.Dispose();
    // If base type implements dispose, call it.
    base.Dispose(); 
    GC.SuppressFinalize(this);  
  }

  // Free your own state (not other state you hold) 
  // and give your base class a chance to finalize. 
  ~ResourceWrapper (){
     freeState();
  }
}