GtkSharp/doc/en/GLib/InputStream.xml
Bertrand Lorentz a9a9c407a9 doc: Auto-fill docs for IntPtr constructors using gen-intptr-ctor-docs
The gen-intptr-ctor-docs automatically fills in the boilerplate
documentation for the IntPtr constructors.
2013-12-04 21:23:25 +01:00

549 lines
24 KiB
XML

<Type Name="InputStream" FullName="GLib.InputStream">
<TypeSignature Language="C#" Value="public class InputStream : GLib.Object" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit InputStream extends GLib.Object" />
<AssemblyInfo>
<AssemblyName>gio-sharp</AssemblyName>
</AssemblyInfo>
<Base>
<BaseTypeName>GLib.Object</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="protected InputStream ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<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 InputStream (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="ClearPending">
<MemberSignature Language="C#" Value="public void ClearPending ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ClearPending() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public bool Close (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Close(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</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="CloseAsync">
<MemberSignature Language="C#" Value="public void CloseAsync (int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CloseAsync(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# 2.14" />
</Docs>
</Member>
<Member MemberName="CloseFinish">
<MemberSignature Language="C#" Value="public bool CloseFinish (GLib.IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool CloseFinish(class GLib.IAsyncResult result) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">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="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.InputStream" />.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="HasPending">
<MemberSignature Language="C#" Value="public bool HasPending { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasPending" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</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="IsClosed">
<MemberSignature Language="C#" Value="public bool IsClosed { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsClosed" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</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="OnCloseAsync">
<MemberSignature Language="C#" Value="protected virtual void OnCloseAsync (int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnCloseAsync(int32 io_priority, class GLib.Cancellable cancellable, class GLib.AsyncReadyCallback cb) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideCloseAsync", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<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# 2.14" />
</Docs>
</Member>
<Member MemberName="OnCloseFinish">
<MemberSignature Language="C#" Value="protected virtual bool OnCloseFinish (GLib.IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool OnCloseFinish(class GLib.IAsyncResult result) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideCloseFinish", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">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="OnCloseFn">
<MemberSignature Language="C#" Value="protected virtual bool OnCloseFn (GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool OnCloseFn(class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideCloseFn", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</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="OnReadAsync">
<MemberSignature Language="C#" Value="protected virtual void OnReadAsync (IntPtr buffer, ulong count, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnReadAsync(native int buffer, unsigned int64 count, int32 io_priority, class GLib.Cancellable cancellable, class GLib.AsyncReadyCallback cb) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideReadAsync", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.IntPtr" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">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# 2.14" />
</Docs>
</Member>
<Member MemberName="OnReadFinish">
<MemberSignature Language="C#" Value="protected virtual long OnReadFinish (GLib.IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int64 OnReadFinish(class GLib.IAsyncResult result) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideReadFinish", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">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="OnReadFn">
<MemberSignature Language="C#" Value="protected virtual long OnReadFn (IntPtr buffer, ulong count, GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int64 OnReadFn(native int buffer, unsigned int64 count, class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideReadFn", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.IntPtr" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">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="OnSkip">
<MemberSignature Language="C#" Value="protected virtual long OnSkip (ulong count, GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int64 OnSkip(unsigned int64 count, class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSkip", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="count">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="OnSkipAsync">
<MemberSignature Language="C#" Value="protected virtual void OnSkipAsync (ulong count, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnSkipAsync(unsigned int64 count, int32 io_priority, class GLib.Cancellable cancellable, class GLib.AsyncReadyCallback cb) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSkipAsync", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="count">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# 2.14" />
</Docs>
</Member>
<Member MemberName="OnSkipFinish">
<MemberSignature Language="C#" Value="protected virtual long OnSkipFinish (GLib.IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int64 OnSkipFinish(class GLib.IAsyncResult result) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSkipFinish", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">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="Read">
<MemberSignature Language="C#" Value="public long Read (byte[] buffer, ulong count, GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int64 Read(unsigned int8[] buffer, unsigned int64 count, class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">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="ReadAll">
<MemberSignature Language="C#" Value="public bool ReadAll (byte[] buffer, ulong count, out ulong bytes_read, GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool ReadAll(unsigned int8[] buffer, unsigned int64 count, unsigned int64 bytes_read, class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="bytes_read" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">To be added.</param>
<param name="bytes_read">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="ReadAsync">
<MemberSignature Language="C#" Value="public void ReadAsync (byte[] buffer, ulong count, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReadAsync(unsigned int8[] buffer, unsigned int64 count, 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="buffer" Type="System.Byte[]" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">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# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadFinish">
<MemberSignature Language="C#" Value="public long ReadFinish (GLib.IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int64 ReadFinish(class GLib.IAsyncResult result) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">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="SetPending">
<MemberSignature Language="C#" Value="public bool SetPending ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetPending() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="Skip">
<MemberSignature Language="C#" Value="public long Skip (ulong count, GLib.Cancellable cancellable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int64 Skip(unsigned int64 count, class GLib.Cancellable cancellable) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="count">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="SkipAsync">
<MemberSignature Language="C#" Value="public void SkipAsync (ulong count, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SkipAsync(unsigned int64 count, 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="count" Type="System.UInt64" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="count">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# 2.14" />
</Docs>
</Member>
<Member MemberName="SkipFinish">
<MemberSignature Language="C#" Value="public long SkipFinish (GLib.IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int64 SkipFinish(class GLib.IAsyncResult result) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">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>