<Type Name="HTMLStream" FullName="Gtk.HTMLStream"> <TypeSignature Language="C#" Value="public sealed struct HTMLStream;" Maintainer="auto" /> <AssemblyInfo> <AssemblyName>gtkhtml-sharp</AssemblyName> <AssemblyPublicKey> </AssemblyPublicKey> <AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyCulture>neutral</AssemblyCulture> <Attributes /> </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> <summary>Handles streaming I/O for <see cref="T:Gtk.HTML" />.</summary> <remarks>TODO: needs examples.</remarks> </Docs> <Base> <BaseTypeName>System.ValueType</BaseTypeName> </Base> <Interfaces /> <Attributes /> <Members> <Member MemberName="LogNew"> <MemberSignature Language="C#" Value="public static Gtk.HTMLStream LogNew (Gtk.HTML html, Gtk.HTMLStream stream);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gtk.HTMLStream</ReturnType> </ReturnValue> <Parameters> <Parameter Name="html" Type="Gtk.HTML" /> <Parameter Name="stream" Type="Gtk.HTMLStream" /> </Parameters> <Docs> <summary>To be added</summary> <param name="html">A <see cref="T:Gtk.HTML" /></param> <param name="stream">A <see cref="T:Gtk.HTMLStream" /></param> <returns>A <see cref="T:Gtk.HTMLStream" /></returns> <remarks /> </Docs> </Member> <Member MemberName="Write"> <MemberSignature Language="C#" Value="public void Write (string buffer);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="buffer" Type="System.String" /> </Parameters> <Docs> <summary>Writes the HTML out to <paramref name="buffer" /></summary> <param name="buffer">A <see cref="T:System.String" /></param> <remarks /> </Docs> </Member> <Member MemberName="Destroy"> <MemberSignature Language="C#" Value="public void Destroy ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Destroy the stream object and dispose of the memory it uses.</summary> <remarks /> </Docs> </Member> <Member MemberName="Close"> <MemberSignature Language="C#" Value="public void Close (Gtk.HTMLStreamStatus status);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="status" Type="Gtk.HTMLStreamStatus" /> </Parameters> <Docs> <summary>Close the stream.</summary> <param name="status">A <see cref="T:Gtk.HTMLStreamStatus" /></param> <remarks /> </Docs> </Member> <Member MemberName="Vprintf"> <MemberSignature Language="C#" Value="public int Vprintf (string format, IntPtr ap);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="format" Type="System.String" /> <Parameter Name="ap" Type="System.IntPtr" /> </Parameters> <Docs> <summary>To be added</summary> <param name="format">A <see cref="T:System.String" /></param> <param name="ap">A <see cref="T:IntPtr" /></param> <returns>A <see cref="T:System.Int32" /></returns> <remarks /> </Docs> </Member> <Member MemberName="Write"> <MemberSignature Language="C#" Value="public void Write (byte [] buffer, ulong size);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="buffer" Type="System.Byte[]" /> <Parameter Name="size" Type="System.UInt64" /> </Parameters> <Docs> <summary>Write the HTML to <paramref name="buffer" />.</summary> <param name="buffer">a <see cref="T:System.Byte" /></param> <param name="size">a <see cref="T:System.UInt64" /></param> <remarks /> </Docs> </Member> <Member MemberName="Types"> <MemberSignature Language="C#" Value="public string Types { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary>To be added</summary> <returns>A <see cref="T:System.String" /></returns> <remarks /> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public HTMLStream (IntPtr raw);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="raw" Type="System.IntPtr" /> </Parameters> <Docs> <summary>Constructor for internal use only. Do not use.</summary> <param name="raw">a <see cref="T:System.IntPtr" />, the underlying C objject.</param> <returns>a <see cref="T:Gtk.HTMLStream" /></returns> <remarks /> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public HTMLStream (Gtk.HTML html, Gtk.HTMLStreamTypesFunc type_func, Gtk.HTMLStreamWriteFunc write_func, Gtk.HTMLStreamCloseFunc close_func);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="html" Type="Gtk.HTML" /> <Parameter Name="type_func" Type="Gtk.HTMLStreamTypesFunc" /> <Parameter Name="write_func" Type="Gtk.HTMLStreamWriteFunc" /> <Parameter Name="close_func" Type="Gtk.HTMLStreamCloseFunc" /> </Parameters> <Docs> <summary>Constructor.</summary> <param name="html">a <see cref="T:Gtk.HTML" /></param> <param name="type_func">a <see cref="T:Gtk.HTMLStreamTypesFunc" /></param> <param name="write_func">a <see cref="T:Gtk.HTMLStreamWriteFunc" /></param> <param name="close_func">a <see cref="T:Gtk.HTMLStreamCloseFunc" /></param> <returns>a <see cref="T:Gtk.HTMLStream" /></returns> <remarks /> </Docs> </Member> <Member MemberName="Write"> <MemberSignature Language="C#" Value="public void Write (byte [] buffer, int size);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="buffer" Type="System.Byte[]" /> <Parameter Name="size" Type="System.Int32" /> </Parameters> <Docs> <summary>Write the HTML to <paramref name="buffer" />.</summary> <param name="buffer">a <see cref="T:System.Byte" /></param> <param name="size">a <see cref="T:System.Int32" /></param> <remarks>Use the ulong size overload instead for 64 bit deployments.</remarks> </Docs> </Member> </Members> </Type>