Difference between revisions of "API:BinaryWriter"

From Kerbal Space Program Wiki
Jump to: navigation, search
 
(One intermediate revision 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.BinaryWriter, but with added IDisposable methods (for use in using structures), and a factory method instead of constructors.
 
|summary=Identical to System.IO.BinaryWriter, but with added IDisposable methods (for use in using structures), and a factory method instead of constructors.
 
}}
 
}}
 +
{{PropertiesStart}}
 +
{{Property
 +
|type=Stream
 +
|name=BaseStream
 +
|desc=
 +
|hasget=1
 +
|hasset=
 +
}}
 +
{{PropertiesEnd}}
 
{{MethodsStart}}
 
{{MethodsStart}}
 
{{StaticMethod
 
{{StaticMethod
Line 9: Line 19:
 
|returndesc=
 
|returndesc=
 
|name=CreateForType<T>
 
|name=CreateForType<T>
|args={{arg|string|filename}}, {{arg|Vessel|flight|default = null}}
+
|args={{arg|string|filename}}, {{arg|Vessel|flight|default=null}}
|desc=Factory method for creating a BinaryWriter for the desired filename.
+
|desc=Create a binary file writer.
 
}}
 
}}
 
{{Method
 
{{Method
Line 16: Line 26:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=string value
+
|args={{arg|string|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 23: Line 33:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=ulong value
+
|args={{arg|ulong|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 30: Line 40:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=char ch
+
|args={{arg|char|ch}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 44: Line 54:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=byte[] buffer
+
|args={{arg|byte|buffer|array=[]}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 51: Line 61:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=char[] chars
+
|args={{arg|char|chars|array=[]}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 58: Line 68:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=ushort value
+
|args={{arg|ushort|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 65: Line 75:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=sbyte value
+
|args={{arg|sbyte|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 72: Line 82:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=byte value
+
|args={{arg|byte|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 79: Line 89:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=bool value
+
|args={{arg|bool|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 93: Line 103:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=short value
+
|args={{arg|short|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 100: Line 110:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=double value
+
|args={{arg|double|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 107: Line 117:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=decimal value
+
|args={{arg|decimal|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 114: Line 124:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=float value
+
|args={{arg|float|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 121: Line 131:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=uint value
+
|args={{arg|uint|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 128: Line 138:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=int value
+
|args={{arg|int|value}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 135: Line 145:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=char[] chars, int index, int count
+
|args={{arg|char|chars|array=[]}}, {{arg|int|index}}, {{arg|int|count}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 142: Line 152:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=byte[] buffer, int index, int count
+
|args={{arg|byte|buffer|array=[]}}, {{arg|int|index}}, {{arg|int|count}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 149: Line 159:
 
|returndesc=
 
|returndesc=
 
|name=Seek
 
|name=Seek
|args=int offset, KSP.IO.SeekOrigin origin
+
|args={{arg|int|offset}}, {{arg|KSP.IO.SeekOrigin|origin}}
 
|desc=
 
|desc=
 
}}
 
}}
Line 163: Line 173:
 
|returndesc=
 
|returndesc=
 
|name=Write
 
|name=Write
|args=long value
+
|args={{arg|long|value}}
 
|desc=
 
|desc=
 
}}
 
}}
 
{{MethodsEnd}}
 
{{MethodsEnd}}

Latest revision as of 23:42, 12 October 2012

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

BinaryWriter Class

Identical to System.IO.BinaryWriter, 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 BinaryWriter.

Signature Description
Stream BaseStream { get; }

Methods

The following are methods included in BinaryWriter.

Signature Description
static BinaryWriter CreateForType<T>(string filename, Vessel flight = null) Create a binary file writer.
void Write(string value)
void Write(ulong value)
void Write(char ch)
void Close()
void Write(byte[] buffer)
void Write(char[] chars)
void Write(ushort value)
void Write(sbyte value)
void Write(byte value)
void Write(bool value)
void Flush()
void Write(short value)
void Write(double value)
void Write(decimal value)
void Write(float value)
void Write(uint value)
void Write(int value)
void Write(char[] chars, int index, int count)
void Write(byte[] buffer, int index, int count)
long Seek(int offset, KSP.IO.SeekOrigin origin)
void Dispose()
void Write(long value)