backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/System/IO/MemoryStream.html
Tom Lint 92e29ba3dd Fixed compiler errors 
Regenerated JavaDoc
Updated whitespace usage
Added LWJGL libraries and binaries
2013-10-15 12:34:51 +02:00

854 lines
43 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="nl">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:25:31 CEST 2013 -->
<title>MemoryStream</title>
<meta name="date" content="2013-10-15">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MemoryStream";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MemoryStream.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../System/IO/IOException.html" title="class in System.IO"><span class="strong">Prev Class</span></a></li>
<li><a href="../../System/IO/PathTooLongException.html" title="class in System.IO"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?System/IO/MemoryStream.html" target="_top">Frames</a></li>
<li><a href="MemoryStream.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_System.IO.Stream">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">System.IO</div>
<h2 title="Class MemoryStream" class="title">Class MemoryStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../System/IO/Stream.html" title="class in System.IO">System.IO.Stream</a></li>
<li>
<ul class="inheritance">
<li>System.IO.MemoryStream</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../System/IDisposable.html" title="interface in System">IDisposable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">MemoryStream</span>
extends <a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></pre>
<div class="block">Defines a stream whose backing store is memory.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Halofreak1990</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_System.IO.Stream">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;System.IO.<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></h3>
<code><a href="../../System/IO/Stream.html#Null">Null</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../System/IO/MemoryStream.html#MemoryStream()">MemoryStream</a></strong>()</code>
<div class="block">Initializes a new instance of the MemoryStream class with an expandable capacity initialized to zero.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../System/IO/MemoryStream.html#MemoryStream(byte[])">MemoryStream</a></strong>(byte[]&nbsp;buffer)</code>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified byte array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../System/IO/MemoryStream.html#MemoryStream(byte[], boolean)">MemoryStream</a></strong>(byte[]&nbsp;buffer,
boolean&nbsp;writable)</code>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified byte array with the CanWrite property set as specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../System/IO/MemoryStream.html#MemoryStream(byte[], int, int)">MemoryStream</a></strong>(byte[]&nbsp;buffer,
int&nbsp;index,
int&nbsp;count)</code>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified region (index) of a byte array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../System/IO/MemoryStream.html#MemoryStream(byte[], int, int, boolean)">MemoryStream</a></strong>(byte[]&nbsp;buffer,
int&nbsp;index,
int&nbsp;count,
boolean&nbsp;writable)</code>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified region of a byte array, with the CanWrite property set as specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../System/IO/MemoryStream.html#MemoryStream(byte[], int, int, boolean, boolean)">MemoryStream</a></strong>(byte[]&nbsp;buffer,
int&nbsp;index,
int&nbsp;count,
boolean&nbsp;writable,
boolean&nbsp;publiclyVisible)</code>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified region of a byte array, with the CanWrite property set as specified, and the ability to call GetBuffer set as specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../System/IO/MemoryStream.html#MemoryStream(int)">MemoryStream</a></strong>(int&nbsp;capacity)</code>
<div class="block">Initializes a new instance of the MemoryStream class with an expandable capacity initialized as specified.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#CanRead()">CanRead</a></strong>()</code>
<div class="block">When overridden in a derived class, gets a value indicating whether the current stream supports reading.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#CanSeek()">CanSeek</a></strong>()</code>
<div class="block">When overridden in a derived class, gets a value indicating whether the current stream supports seeking.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#CanWrite()">CanWrite</a></strong>()</code>
<div class="block">When overridden in a derived class, gets a value indicating whether the current stream supports writing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#Dispose(boolean)">Dispose</a></strong>(boolean&nbsp;disposing)</code>
<div class="block">Releases the unmanaged resources used by the MemoryStream and optionally releases the managed resources.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#Flush()">Flush</a></strong>()</code>
<div class="block">Overrides Flush so that no action is performed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#GetBuffer()">GetBuffer</a></strong>()</code>
<div class="block">Returns the array of unsigned bytes from which this stream was created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#getCapacity()">getCapacity</a></strong>()</code>
<div class="block">Gets the number of bytes allocated for this stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#getPosition()">getPosition</a></strong>()</code>
<div class="block">Gets the current position within the stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#Length()">Length</a></strong>()</code>
<div class="block">When overridden in a derived class, gets the length in bytes of the stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#Read(byte[], int, int)">Read</a></strong>(byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;count)</code>
<div class="block">Reads a block of bytes from the current stream and writes the data to buffer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#ReadByte()">ReadByte</a></strong>()</code>
<div class="block">Reads a byte from the current stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#Seek(long, System.IO.SeekOrigin)">Seek</a></strong>(long&nbsp;offset,
<a href="../../System/IO/SeekOrigin.html" title="enum in System.IO">SeekOrigin</a>&nbsp;origin)</code>
<div class="block">Sets the position within the current stream to the specified value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#setCapacity(int)">setCapacity</a></strong>(int&nbsp;value)</code>
<div class="block">Sets the number of bytes allocated for this stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#SetLength(long)">SetLength</a></strong>(long&nbsp;value)</code>
<div class="block">Sets the length of the current stream to the specified value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#setPosition(long)">setPosition</a></strong>(long&nbsp;value)</code>
<div class="block">Sets the current position within the stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#ToArray()">ToArray</a></strong>()</code>
<div class="block">Writes the entire stream contents to a byte array, regardless of the Position property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#Write(byte[], int, int)">Write</a></strong>(byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;count)</code>
<div class="block">Writes a block of bytes to the current stream using data read from buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#WriteByte(byte)">WriteByte</a></strong>(byte&nbsp;value)</code>
<div class="block">Writes a byte to the current stream at the current position.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#WriteTo(java.io.OutputStream)">WriteTo</a></strong>(java.io.OutputStream&nbsp;stream)</code>
<div class="block">Writes the entire contents of this memory stream to a java.io.OutputStream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/MemoryStream.html#WriteTo(System.IO.Stream)">WriteTo</a></strong>(<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a>&nbsp;stream)</code>
<div class="block">Writes the entire contents of this memory stream to another stream.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_System.IO.Stream">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;System.IO.<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></h3>
<code><a href="../../System/IO/Stream.html#BeginRead(byte[], int, int, System.AsyncCallback, java.lang.Object)">BeginRead</a>, <a href="../../System/IO/Stream.html#BeginWrite(byte[], int, int, System.AsyncCallback, java.lang.Object)">BeginWrite</a>, <a href="../../System/IO/Stream.html#CanTimeout()">CanTimeout</a>, <a href="../../System/IO/Stream.html#Close()">Close</a>, <a href="../../System/IO/Stream.html#Dispose()">Dispose</a>, <a href="../../System/IO/Stream.html#EndRead(System.IAsyncResult)">EndRead</a>, <a href="../../System/IO/Stream.html#EndWrite(System.IAsyncResult)">EndWrite</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MemoryStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MemoryStream</h4>
<pre>public&nbsp;MemoryStream()</pre>
<div class="block">Initializes a new instance of the MemoryStream class with an expandable capacity initialized to zero.</div>
</li>
</ul>
<a name="MemoryStream(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MemoryStream</h4>
<pre>public&nbsp;MemoryStream(int&nbsp;capacity)</pre>
<div class="block">Initializes a new instance of the MemoryStream class with an expandable capacity initialized as specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capacity</code> - The initial size of the internal array in bytes.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - capacity is negative.</dd></dl>
</li>
</ul>
<a name="MemoryStream(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MemoryStream</h4>
<pre>public&nbsp;MemoryStream(byte[]&nbsp;buffer)</pre>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified byte array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - The array of unsigned bytes from which to create the current stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - buffer is null.</dd></dl>
</li>
</ul>
<a name="MemoryStream(byte[], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MemoryStream</h4>
<pre>public&nbsp;MemoryStream(byte[]&nbsp;buffer,
boolean&nbsp;writable)</pre>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified byte array with the CanWrite property set as specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - The array of unsigned bytes from which to create this stream.</dd><dd><code>writable</code> - The setting of the CanWrite property, which determines whether the stream supports writing.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - buffer is null.</dd></dl>
</li>
</ul>
<a name="MemoryStream(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MemoryStream</h4>
<pre>public&nbsp;MemoryStream(byte[]&nbsp;buffer,
int&nbsp;index,
int&nbsp;count)</pre>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified region (index) of a byte array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - The array of unsigned bytes from which to create this stream.</dd><dd><code>index</code> - The index into buffer at which the stream begins.</dd><dd><code>count</code> - The length of the stream in bytes.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - buffer is null.</dd>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - index or count is less than zero.</dd>
<dd><code><a href="../../System/ArgumentException.html" title="class in System">ArgumentException</a></code> - The sum of index and count is greater than the length of buffer.</dd></dl>
</li>
</ul>
<a name="MemoryStream(byte[], int, int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MemoryStream</h4>
<pre>public&nbsp;MemoryStream(byte[]&nbsp;buffer,
int&nbsp;index,
int&nbsp;count,
boolean&nbsp;writable)</pre>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified region of a byte array, with the CanWrite property set as specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - The array of bytes from which to create this stream.</dd><dd><code>index</code> - The index into buffer at which the stream begins.</dd><dd><code>count</code> - The length of the stream in bytes.</dd><dd><code>writable</code> - The setting of the CanWrite property, which determines whether the stream supports writing.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - buffer is null.</dd>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - index or count is less than zero.</dd>
<dd><code><a href="../../System/ArgumentException.html" title="class in System">ArgumentException</a></code> - The sum of index and count is greater than the length of buffer.</dd></dl>
</li>
</ul>
<a name="MemoryStream(byte[], int, int, boolean, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MemoryStream</h4>
<pre>public&nbsp;MemoryStream(byte[]&nbsp;buffer,
int&nbsp;index,
int&nbsp;count,
boolean&nbsp;writable,
boolean&nbsp;publiclyVisible)</pre>
<div class="block">Initializes a new non-resizable instance of the MemoryStream class based on the specified region of a byte array, with the CanWrite property set as specified, and the ability to call GetBuffer set as specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - The array of bytes from which to create this stream.</dd><dd><code>index</code> - The index into buffer at which the stream begins.</dd><dd><code>count</code> - The length of the stream in bytes.</dd><dd><code>writable</code> - The setting of the CanWrite property, which determines whether the stream supports writing.</dd><dd><code>publiclyVisible</code> - true to enable GetBuffer, which returns the byte array from which the stream was created; otherwise, false.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - buffer is null.</dd>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - index or count is less than zero.</dd>
<dd><code><a href="../../System/ArgumentException.html" title="class in System">ArgumentException</a></code> - The sum of index and count is greater than the length of buffer.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="CanRead()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CanRead</h4>
<pre>public&nbsp;boolean&nbsp;CanRead()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../System/IO/Stream.html#CanRead()">Stream</a></code></strong></div>
<div class="block">When overridden in a derived class, gets a value indicating whether the current stream supports reading.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#CanRead()">CanRead</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the stream supports reading; otherwise, false.</dd></dl>
</li>
</ul>
<a name="CanSeek()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CanSeek</h4>
<pre>public&nbsp;boolean&nbsp;CanSeek()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../System/IO/Stream.html#CanSeek()">Stream</a></code></strong></div>
<div class="block">When overridden in a derived class, gets a value indicating whether the current stream supports seeking.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#CanSeek()">CanSeek</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the stream supports seeking; otherwise, false.</dd></dl>
</li>
</ul>
<a name="CanWrite()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CanWrite</h4>
<pre>public&nbsp;boolean&nbsp;CanWrite()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../System/IO/Stream.html#CanWrite()">Stream</a></code></strong></div>
<div class="block">When overridden in a derived class, gets a value indicating whether the current stream supports writing.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#CanWrite()">CanWrite</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the stream supports writing; otherwise, false.</dd></dl>
</li>
</ul>
<a name="getCapacity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapacity</h4>
<pre>public&nbsp;int&nbsp;getCapacity()</pre>
<div class="block">Gets the number of bytes allocated for this stream.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The length of the usable portion of the buffer for the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current stream is closed.</dd></dl>
</li>
</ul>
<a name="setCapacity(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCapacity</h4>
<pre>public&nbsp;void&nbsp;setCapacity(int&nbsp;value)</pre>
<div class="block">Sets the number of bytes allocated for this stream.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - A capacity is set that is negative or less than the current length of the stream.</dd>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current stream is closed.</dd>
<dd><code><a href="../../System/NotSupportedException.html" title="class in System">NotSupportedException</a></code> - set is invoked on a stream whose capacity cannot be modified.</dd></dl>
</li>
</ul>
<a name="Length()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Length</h4>
<pre>public&nbsp;long&nbsp;Length()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../System/IO/Stream.html#Length()">Stream</a></code></strong></div>
<div class="block">When overridden in a derived class, gets the length in bytes of the stream.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#Length()">Length</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A long value representing the length of the stream in bytes.</dd></dl>
</li>
</ul>
<a name="getPosition()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition</h4>
<pre>public&nbsp;long&nbsp;getPosition()</pre>
<div class="block">Gets the current position within the stream.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#getPosition()">getPosition</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The current position within the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The stream is closed.</dd></dl>
</li>
</ul>
<a name="setPosition(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPosition</h4>
<pre>public&nbsp;void&nbsp;setPosition(long&nbsp;value)</pre>
<div class="block">Sets the current position within the stream.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#setPosition(long)">setPosition</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The new position within the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The stream is closed.</dd>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - The position is set to a negative value or a value greater than MaxValue.</dd></dl>
</li>
</ul>
<a name="Dispose(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dispose</h4>
<pre>protected&nbsp;void&nbsp;Dispose(boolean&nbsp;disposing)</pre>
<div class="block">Releases the unmanaged resources used by the MemoryStream and optionally releases the managed resources.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#Dispose(boolean)">Dispose</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>disposing</code> - true to release both managed and unmanaged resources; false to release only unmanaged resources.</dd></dl>
</li>
</ul>
<a name="Flush()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Flush</h4>
<pre>public&nbsp;void&nbsp;Flush()</pre>
<div class="block">Overrides Flush so that no action is performed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#Flush()">Flush</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
</dl>
</li>
</ul>
<a name="GetBuffer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GetBuffer</h4>
<pre>public&nbsp;byte[]&nbsp;GetBuffer()</pre>
<div class="block">Returns the array of unsigned bytes from which this stream was created.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The byte array from which this stream was created, or the underlying array if a byte array was not provided to the MemoryStream constructor during construction of the current instance.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/UnauthorizedAccessException.html" title="class in System">UnauthorizedAccessException</a></code> - The MemoryStream instance was not created with a publicly visible buffer.</dd></dl>
</li>
</ul>
<a name="ReadByte()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadByte</h4>
<pre>public&nbsp;int&nbsp;ReadByte()</pre>
<div class="block">Reads a byte from the current stream.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#ReadByte()">ReadByte</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The byte cast to a Int32, or -1 if the end of the stream has been reached.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current stream instance is closed.</dd></dl>
</li>
</ul>
<a name="Read(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Read</h4>
<pre>public&nbsp;int&nbsp;Read(byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;count)</pre>
<div class="block">Reads a block of bytes from the current stream and writes the data to buffer.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#Read(byte[], int, int)">Read</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - When this method returns, contains the specified byte array with the values between offset and (offset + count - 1) replaced by the characters read from the current stream.</dd><dd><code>offset</code> - The byte offset in buffer at which to begin reading.</dd><dd><code>count</code> - The maximum number of bytes to read.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The total number of bytes written into the buffer. This can be less than the number of bytes requested if that number of bytes are not currently available, or zero if the end of the stream is reached before any bytes are read.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current stream instance is closed.</dd>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - buffer is null.</dd>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - offset or count is negative.</dd>
<dd><code><a href="../../System/ArgumentException.html" title="class in System">ArgumentException</a></code> - offset subtracted from the buffer length is less than count.</dd></dl>
</li>
</ul>
<a name="Seek(long, System.IO.SeekOrigin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Seek</h4>
<pre>public&nbsp;long&nbsp;Seek(long&nbsp;offset,
<a href="../../System/IO/SeekOrigin.html" title="enum in System.IO">SeekOrigin</a>&nbsp;origin)</pre>
<div class="block">Sets the position within the current stream to the specified value.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#Seek(long, System.IO.SeekOrigin)">Seek</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - The new position within the stream. This is relative to the origin parameter, and can be positive or negative.</dd><dd><code>origin</code> - A value of type SeekOrigin, which acts as the seek reference point.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The new position within the stream, calculated by combining the initial reference point and the offset.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - offset is greater than MaxValue.</dd>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current stream instance is closed.</dd>
<dd><code><a href="../../System/IO/IOException.html" title="class in System.IO">IOException</a></code> - Seeking is attempted before the beginning of the stream.</dd>
<dd><code><a href="../../System/ArgumentException.html" title="class in System">ArgumentException</a></code></dd></dl>
</li>
</ul>
<a name="SetLength(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SetLength</h4>
<pre>public&nbsp;void&nbsp;SetLength(long&nbsp;value)</pre>
<div class="block">Sets the length of the current stream to the specified value.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#SetLength(long)">SetLength</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The value at which to set the length.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code> - value is negative or is greater than the maximum length of the MemoryStream, where the maximum length is (MaxValue - origin), and origin is the index into the underlying buffer at which the stream starts.</dd>
<dd><code><a href="../../System/NotSupportedException.html" title="class in System">NotSupportedException</a></code> - The current stream is not resizable and value is larger than the current capacity.-or- The current stream does not support writing.</dd></dl>
</li>
</ul>
<a name="ToArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ToArray</h4>
<pre>public&nbsp;byte[]&nbsp;ToArray()</pre>
<div class="block">Writes the entire stream contents to a byte array, regardless of the Position property.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A new byte array.</dd></dl>
</li>
</ul>
<a name="WriteByte(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WriteByte</h4>
<pre>public&nbsp;void&nbsp;WriteByte(byte&nbsp;value)</pre>
<div class="block">Writes a byte to the current stream at the current position.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#WriteByte(byte)">WriteByte</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The byte to write.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/NotSupportedException.html" title="class in System">NotSupportedException</a></code> - The stream does not support writing. For additional information see CanWrite.-or- The current position is at the end of the stream, and the capacity cannot be modified.</dd>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current stream is closed.</dd></dl>
</li>
</ul>
<a name="Write(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;void&nbsp;Write(byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;count)</pre>
<div class="block">Writes a block of bytes to the current stream using data read from buffer.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IO/Stream.html#Write(byte[], int, int)">Write</a></code>&nbsp;in class&nbsp;<code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - The buffer to write data from.</dd><dd><code>offset</code> - The byte offset in buffer at which to begin writing from.</dd><dd><code>count</code> - The maximum number of bytes to write.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current stream is closed.</dd>
<dd><code><a href="../../System/NotSupportedException.html" title="class in System">NotSupportedException</a></code> - The stream does not support writing. For additional information see CanWrite.-or- The current position is closer than count bytes to the end of the stream, and the capacity cannot be modified.</dd>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - buffer is null.</dd>
<dd><code><a href="../../System/IO/IOException.html" title="class in System.IO">IOException</a></code> - An I/O error occurs.</dd></dl>
</li>
</ul>
<a name="WriteTo(System.IO.Stream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WriteTo</h4>
<pre>public&nbsp;void&nbsp;WriteTo(<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a>&nbsp;stream)</pre>
<div class="block">Writes the entire contents of this memory stream to another stream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - The stream to write this memory stream to.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - stream is null.</dd>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current or target stream is closed.</dd></dl>
</li>
</ul>
<a name="WriteTo(java.io.OutputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WriteTo</h4>
<pre>public&nbsp;void&nbsp;WriteTo(java.io.OutputStream&nbsp;stream)</pre>
<div class="block">Writes the entire contents of this memory stream to a java.io.OutputStream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - The stream to write this memory stream to.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code> - stream is null.</dd>
<dd><code><a href="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code> - The current or target stream is closed.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MemoryStream.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../System/IO/IOException.html" title="class in System.IO"><span class="strong">Prev Class</span></a></li>
<li><a href="../../System/IO/PathTooLongException.html" title="class in System.IO"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?System/IO/MemoryStream.html" target="_top">Frames</a></li>
<li><a href="MemoryStream.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_System.IO.Stream">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink