Ryujinx-GtkSharp/doc/en/Gda/Error.xml
Fawad Halim 9e9ba80d18 GDA documentation contributed by Nestor Salceda <wizito@gentelibre.org>
svn path=/trunk/gtk-sharp/; revision=33581
2004-09-08 14:56:46 +00:00

233 lines
7.3 KiB
XML

<Type Name="Error" FullName="Gda.Error">
<TypeSignature Language="C#" Value="public class Error : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gda-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>
<para>
Management of errors.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="ListFree">
<MemberSignature Language="C#" Value="public static void ListFree (GLib.List errors);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="errors" Type="GLib.List" />
</Parameters>
<Docs>
<summary>
<para>
Frees all error objects in the list and the list itself. After this function has been called, the errors parameter doesn't point to valid storage any more.
</para>
</summary>
<param name="errors">a <see cref="T:GLib.List" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ListCopy">
<MemberSignature Language="C#" Value="public static GLib.List ListCopy (GLib.List errors);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="errors" Type="GLib.List" />
</Parameters>
<Docs>
<summary>
<para>
Creates a new list which contains the same errors as errors and adds a reference for each error in the list.
</para>
</summary>
<param name="errors">a <see cref="T:GLib.List" /></param>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Free">
<MemberSignature Language="C#" Value="public void Free ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Frees the memory allocated by the error object.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Error (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gda.Error" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Error ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor.</summary>
<returns>a <see cref="T:Gda.Error" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Sqlstate">
<MemberSignature Language="C#" Value="public string Sqlstate { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets error's SQL state.
</para>
<para>
Sets error's SQL state.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Source">
<MemberSignature Language="C#" Value="public string Source { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets error's source.
</para>
<para>
Sets error's source.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Number">
<MemberSignature Language="C#" Value="public long Number { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets error's number.
</para>
<para>
Sets error's number.
</para>
</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets error's description.
</para>
<para>
Sets error's description
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gda.Error" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Error (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gda.Error" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
</Members>
</Type>