Difference between revisions of "API:FileStream"

From Kerbal Space Program Wiki
Jump to: navigation, search
m (N3X15 moved page FileStream to API:FileStream)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<!-- Autogenerated by WRAPTOOL.  Yell at N3X15 if it breaks. -->
+
<!-- Autogenerated by DOCTOOL.  Yell at N3X15 if it breaks. -->
 
{{Namespace:KSP.IO}}
 
{{Namespace:KSP.IO}}
 
{{Class
 
{{Class
Line 5: Line 5:
 
|summary=summary goes here
 
|summary=summary goes here
 
}}
 
}}
 +
{{PropertiesStart}}
 +
{{Property
 +
|type=long
 +
|name=Length
 +
|desc=
 +
|hasget=1
 +
|hasset=
 +
}}
 +
{{Property
 +
|type=bool
 +
|name=IsAsync
 +
|desc=
 +
|hasget=1
 +
|hasset=
 +
}}
 +
{{Property
 +
|type=bool
 +
|name=CanWrite
 +
|desc=
 +
|hasget=1
 +
|hasset=
 +
}}
 +
{{Property
 +
|type=bool
 +
|name=CanRead
 +
|desc=
 +
|hasget=1
 +
|hasset=
 +
}}
 +
{{Property
 +
|type=long
 +
|name=Position
 +
|desc=
 +
|hasget=1
 +
|hasset=1
 +
}}
 +
{{Property
 +
|type=string
 +
|name=Name
 +
|desc=
 +
|hasget=1
 +
|hasset=
 +
}}
 +
{{Property
 +
|type=bool
 +
|name=CanSeek
 +
|desc=
 +
|hasget=1
 +
|hasset=
 +
}}
 +
{{PropertiesEnd}}
 
{{MethodsStart}}
 
{{MethodsStart}}
 
{{Method
 
{{Method
Line 10: Line 61:
 
|returndesc=
 
|returndesc=
 
|name=SetLength
 
|name=SetLength
|args=long value
+
|args={{arg|long|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 17: Line 68:
 
|returndesc=
 
|returndesc=
 
|name=WriteByte
 
|name=WriteByte
|args=byte value
+
|args={{arg|byte|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 24: Line 75:
 
|returndesc=
 
|returndesc=
 
|name=Seek
 
|name=Seek
|args=long offset, SeekOrigin origin
+
|args={{arg|long|offset}}, {{arg|SeekOrigin|origin}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 45: Line 96:
 
|returndesc=
 
|returndesc=
 
|name=BeginRead
 
|name=BeginRead
|args=byte[] array, int offset, int numBytes, AsyncCallback userCallback, object stateObject
+
|args={{arg|byte|array|array=[]}}, {{arg|int|offset}}, {{arg|int|numBytes}}, {{arg|AsyncCallback|userCallback}}, {{arg|object|stateObject}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 52: Line 103:
 
|returndesc=
 
|returndesc=
 
|name=BeginWrite
 
|name=BeginWrite
|args=byte[] array, int offset, int numBytes, AsyncCallback userCallback, object stateObject
+
|args={{arg|byte|array|array=[]}}, {{arg|int|offset}}, {{arg|int|numBytes}}, {{arg|AsyncCallback|userCallback}}, {{arg|object|stateObject}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 59: Line 110:
 
|returndesc=
 
|returndesc=
 
|name=Lock
 
|name=Lock
|args=long position, long length
+
|args={{arg|long|position}}, {{arg|long|length}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 66: Line 117:
 
|returndesc=
 
|returndesc=
 
|name=EndWrite
 
|name=EndWrite
|args=IAsyncResult asyncResult
+
|args={{arg|IAsyncResult|asyncResult}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 73: Line 124:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=byte[] array, int offset, int count
+
|args={{arg|byte|array|array=[]}}, {{arg|int|offset}}, {{arg|int|count}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 80: Line 131:
 
|returndesc=
 
|returndesc=
 
|name=Unlock
 
|name=Unlock
|args=long position, long length
+
|args={{arg|long|position}}, {{arg|long|length}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 87: Line 138:
 
|returndesc=
 
|returndesc=
 
|name=Read
 
|name=Read
|args=byte[] array, int offset, int count
+
|args={{arg|byte|array|array=[]}}, {{arg|int|offset}}, {{arg|int|count}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 94: Line 145:
 
|returndesc=
 
|returndesc=
 
|name=EndRead
 
|name=EndRead
|args=IAsyncResult asyncResult
+
|args={{arg|IAsyncResult|asyncResult}}
 
|desc=
 
|desc=
 
}}
 
}}

Latest revision as of 23:45, 12 October 2012

KSP.IO Namespace
BinaryReader · BinaryWriter · File · FileInfo · FileStream · IOException · IOTools · IOUtils · MemoryStream · PluginConfigNode · PluginConfiguration · TextReader · TextWriter

FileStream Class

summary goes here

Properties

The following are public properties available in FileStream.

Signature Description
long Length { get; }
bool IsAsync { get; }
bool CanWrite { get; }
bool CanRead { get; }
long Position { get; set; }
string Name { get; }
bool CanSeek { get; }

Methods

The following are methods included in FileStream.

Signature Description
void SetLength(long value)
void WriteByte(byte value)
long Seek(long offset, SeekOrigin origin)
int ReadByte()
void Dispose()
IAsyncResult BeginRead(byte[] array, int offset, int numBytes, AsyncCallback userCallback, object stateObject)
IAsyncResult BeginWrite(byte[] array, int offset, int numBytes, AsyncCallback userCallback, object stateObject)
void Lock(long position, long length)
void EndWrite(IAsyncResult asyncResult)
void Write(byte[] array, int offset, int count)
void Unlock(long position, long length)
int Read(byte[] array, int offset, int count)
int EndRead(IAsyncResult asyncResult)
void Flush()