GtkSharp/Source/doc/en/GLib/DataInputStream.xml

416 lines
19 KiB
XML
Raw Normal View History

<Type Name="DataInputStream" FullName="GLib.DataInputStream">
<TypeSignature Language="C#" Value="public class DataInputStream : GLib.BufferedInputStream" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DataInputStream extends GLib.BufferedInputStream" />
<AssemblyInfo>
<AssemblyName>gio-sharp</AssemblyName>
</AssemblyInfo>
<Base>
<BaseTypeName>GLib.BufferedInputStream</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataInputStream (GLib.InputStream base_stream);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class GLib.InputStream base_stream) cil managed" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="base_stream" Type="GLib.InputStream" />
</Parameters>
<Docs>
<param name="base_stream">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataInputStream (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">Native object pointer.</param>
<summary>Internal constructor</summary>
<remarks>This is not typically used by C# code. Exposed primarily for use by language bindings to wrap native object instances.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ByteOrder">
<MemberSignature Language="C#" Value="public GLib.DataStreamByteOrder ByteOrder { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype GLib.DataStreamByteOrder ByteOrder" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("byte-order")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>GLib.DataStreamByteOrder</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Docs>
<summary>GType Property.</summary>
<value>The native <see cref="T:GLib.GType" /> value.</value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:GLib.DataInputStream" />.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="NewlineType">
<MemberSignature Language="C#" Value="public GLib.DataStreamNewlineType NewlineType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype GLib.DataStreamNewlineType NewlineType" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("newline-type")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>GLib.DataStreamNewlineType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadByte">
<MemberSignature Language="C#" Value="public byte ReadByte (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8 ReadByte(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadInt16">
<MemberSignature Language="C#" Value="public short ReadInt16 (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int16 ReadInt16(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int16</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadInt32">
<MemberSignature Language="C#" Value="public int ReadInt32 (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 ReadInt32(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadInt64">
<MemberSignature Language="C#" Value="public long ReadInt64 (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int64 ReadInt64(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadLine">
<MemberSignature Language="C#" Value="public string ReadLine (out ulong length, GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ReadLine(unsigned int64 length, class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="length" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="length">To be added.</param>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadLineAsync">
<MemberSignature Language="C#" Value="public void ReadLineAsync (int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReadLineAsync(int32 io_priority, class GLib.Cancellable cancellable, class GLib.AsyncReadyCallback cb) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="ReadLineFinish">
<MemberSignature Language="C#" Value="public string ReadLineFinish (GLib.IAsyncResult result, out ulong length);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ReadLineFinish(class GLib.IAsyncResult result, unsigned int64 length) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
<Parameter Name="length" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="ReadUint16">
<MemberSignature Language="C#" Value="public ushort ReadUint16 (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int16 ReadUint16(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadUint32">
<MemberSignature Language="C#" Value="public uint ReadUint32 (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 ReadUint32(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadUint64">
<MemberSignature Language="C#" Value="public ulong ReadUint64 (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int64 ReadUint64(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadUntil">
<MemberSignature Language="C#" Value="public string ReadUntil (string stop_chars, out ulong length, GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ReadUntil(string stop_chars, unsigned int64 length, class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stop_chars" Type="System.String" />
<Parameter Name="length" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="stop_chars">To be added.</param>
<param name="length">To be added.</param>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadUntilAsync">
<MemberSignature Language="C#" Value="public void ReadUntilAsync (string stop_chars, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReadUntilAsync(string stop_chars, int32 io_priority, class GLib.Cancellable cancellable, class GLib.AsyncReadyCallback cb) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stop_chars" Type="System.String" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="stop_chars">To be added.</param>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="ReadUntilFinish">
<MemberSignature Language="C#" Value="public string ReadUntilFinish (GLib.IAsyncResult result, out ulong length);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ReadUntilFinish(class GLib.IAsyncResult result, unsigned int64 length) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
<Parameter Name="length" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="ReadUpto">
<MemberSignature Language="C#" Value="public string ReadUpto (string stop_chars, out ulong length, GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ReadUpto(string stop_chars, unsigned int64 length, class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stop_chars" Type="System.String" />
<Parameter Name="length" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="stop_chars">To be added.</param>
<param name="length">To be added.</param>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="ReadUptoAsync">
<MemberSignature Language="C#" Value="public void ReadUptoAsync (string stop_chars, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReadUptoAsync(string stop_chars, int32 io_priority, class GLib.Cancellable cancellable, class GLib.AsyncReadyCallback cb) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stop_chars" Type="System.String" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="stop_chars">To be added.</param>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="ReadUptoFinish">
<MemberSignature Language="C#" Value="public string ReadUptoFinish (GLib.IAsyncResult result, out ulong length);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ReadUptoFinish(class GLib.IAsyncResult result, unsigned int64 length) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
<Parameter Name="length" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
</Members>
</Type>