Difference between revisions of "API:BinaryReader"

From Kerbal Space Program Wiki
Jump to: navigation, search
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
<!-- Autogenerated by DOCTOOL.  Yell at N3X15 if it breaks. -->
 
{{Namespace:KSP.IO}}
 
{{Namespace:KSP.IO}}
 
{{Class
 
{{Class
Line 4: Line 5:
 
|summary=Identical to System.IO.BinaryReader, but with added IDisposable methods (for use in using structures), and a factory method instead of constructors.
 
|summary=Identical to System.IO.BinaryReader, but with added IDisposable methods (for use in using structures), and a factory method instead of constructors.
 
}}
 
}}
 +
{{PropertiesStart}}
 +
{{Property
 +
|type=Stream
 +
|name=BaseStream
 +
|desc=Grab the underlying Stream.
 +
|hasget=1
 +
|hasset=
 +
}}
 +
{{PropertiesEnd}}
 
{{MethodsStart}}
 
{{MethodsStart}}
 
{{StaticMethod
 
{{StaticMethod
 
|returntype=BinaryReader
 
|returntype=BinaryReader
−
|returndesc=The binary reader requested
+
|returndesc=
 
|name=CreateForType<T>
 
|name=CreateForType<T>
−
|args=string filename, Vessel flight = null
+
|args={{arg|string|filename|desc=The file to open}}, {{arg|Vessel|flight|default=null|desc=The current Flight object}}
 
|desc=Create a binary reader with the desired filename.
 
|desc=Create a binary reader with the desired filename.
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=void
+
|returntype=short
 +
|returndesc=
 +
|name=ReadInt16
 +
|args=
 +
|desc=
 +
}}
 +
{{Method
 +
|returntype=int
 
|returndesc=
 
|returndesc=
−
|name=Close
+
|name=Read
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=void
+
|returntype=float
 
|returndesc=
 
|returndesc=
−
|name=Dispose
+
|name=ReadSingle
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=int
+
|returntype=void
 
|returndesc=
 
|returndesc=
−
|name=PeekChar
+
|name=Close
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=int
+
|returntype=uint
 
|returndesc=
 
|returndesc=
−
|name=Read
+
|name=ReadUInt32
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=int
+
|returntype=double
 
|returndesc=
 
|returndesc=
−
|name=Read
+
|name=ReadDouble
−
|args=byte[] buffer, int index, int count
+
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=int
+
|returntype=long
 
|returndesc=
 
|returndesc=
−
|name=Read
+
|name=ReadInt64
−
|args=char[] buffer, int index, int count
+
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=bool
+
|returntype=string
 
|returndesc=
 
|returndesc=
−
|name=ReadBoolean
+
|name=ReadString
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=byte
+
|returntype=int
 
|returndesc=
 
|returndesc=
−
|name=ReadByte
+
|name=PeekChar
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=byte[]
+
|returntype=int
 
|returndesc=
 
|returndesc=
−
|name=ReadBytes
+
|name=Read
−
|args=int count
+
|args={{arg|char|buffer|array=[]}}, {{arg|int|index}}, {{arg|int|count}}
 +
|desc=Read a block of {{type|char}}s from the stream.
 
}}
 
}}
 
{{Method
 
{{Method
Line 71: Line 97:
 
|name=ReadChar
 
|name=ReadChar
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=char[]
+
|returntype=bool
 
|returndesc=
 
|returndesc=
−
|name=ReadChars
+
|name=ReadBoolean
−
|args=int count
 
−
}}
 
−
{{Method
 
−
|returntype=decimal
 
−
|returndesc=
 
−
|name=ReadDecimal
 
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=double
+
|returntype=int
 
|returndesc=
 
|returndesc=
−
|name=ReadDouble
+
|name=Read
−
|args=
+
|args={{arg|byte|buffer|array=[]}}, {{arg|int|index}}, {{arg|int|count}}
 +
|desc=Read a block of {{type|byte}}s from the stream.
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=short
+
|returntype=byte
 
|returndesc=
 
|returndesc=
−
|name=ReadInt16
+
|name=ReadByte
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=int
+
|returntype=ushort
 
|returndesc=
 
|returndesc=
−
|name=ReadInt32
+
|name=ReadUInt16
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=long
+
|returntype=char
 +
|array=[]
 
|returndesc=
 
|returndesc=
−
|name=ReadInt64
+
|name=ReadChars
−
|args=
+
|args={{arg|int|count}}
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
Line 113: Line 140:
 
|name=ReadSByte
 
|name=ReadSByte
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=float
+
|returntype=ulong
 
|returndesc=
 
|returndesc=
−
|name=ReadSingle
+
|name=ReadUInt64
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=string
+
|returntype=int
 
|returndesc=
 
|returndesc=
−
|name=ReadString
+
|name=ReadInt32
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=ushort
+
|returntype=decimal
 
|returndesc=
 
|returndesc=
−
|name=ReadUInt16
+
|name=ReadDecimal
 
|args=
 
|args=
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=uint
+
|returntype=byte
 +
|array=[]
 
|returndesc=
 
|returndesc=
−
|name=ReadUInt32
+
|name=ReadBytes
−
|args=
+
|args={{arg|int|count}}
 +
|desc=
 
}}
 
}}
 
{{Method
 
{{Method
−
|returntype=ulong
+
|returntype=void
 
|returndesc=
 
|returndesc=
−
|name=ReadUInt64
+
|name=Dispose
 
|args=
 
|args=
 +
|desc=Close the stream and any resources (e.g. files) it has open.
 
}}
 
}}
 
{{MethodsEnd}}
 
{{MethodsEnd}}

Latest revision as of 09:47, 14 October 2012

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

BinaryReader Class

Identical to System.IO.BinaryReader, but with added IDisposable methods (for use in using structures), and a factory method instead of constructors.

Properties

The following are public properties available in BinaryReader.

Signature Description
Stream BaseStream { get; } Grab the underlying Stream.

Methods

The following are methods included in BinaryReader.

Signature Description
static BinaryReader CreateForType<T>(string filename, Vessel flight = null) Create a binary reader with the desired filename.
short ReadInt16()
int Read()
float ReadSingle()
void Close()
uint ReadUInt32()
double ReadDouble()
long ReadInt64()
string ReadString()
int PeekChar()
int Read(char[] buffer, int index, int count) Read a block of chars from the stream.
char ReadChar()
bool ReadBoolean()
int Read(byte[] buffer, int index, int count) Read a block of bytes from the stream.
byte ReadByte()
ushort ReadUInt16()
char[] ReadChars(int count)
sbyte ReadSByte()
ulong ReadUInt64()
int ReadInt32()
decimal ReadDecimal()
byte[] ReadBytes(int count)
void Dispose() Close the stream and any resources (e.g. files) it has open.
Retrieved from "https://wiki.kerbalspaceprogram.com/index.php?title=API:BinaryReader&oldid=6444"