GtkSharp/doc/en/Gda/Connection.xml
Mike Kestner 704726109a 2004-06-21 Mike Kestner <mkestner@ximian.com>
* en/*/*.xml : document ctor(GType) members via script-fu. 476 TBAs.

svn path=/trunk/gtk-sharp/; revision=30068
2004-06-21 20:33:11 +00:00

520 lines
19 KiB
XML

<Type Name="Connection" FullName="Gda.Connection">
<TypeSignature Language="C#" Value="public class Connection : 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>To be added</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="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="RollbackTransaction">
<MemberSignature Language="C#" Value="public bool RollbackTransaction (Gda.Transaction xaction);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="xaction" Type="Gda.Transaction" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="xaction">a <see cref="T:Gda.Transaction" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BeginTransaction">
<MemberSignature Language="C#" Value="public bool BeginTransaction (Gda.Transaction xaction);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="xaction" Type="Gda.Transaction" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="xaction">a <see cref="T:Gda.Transaction" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ExecuteNonQuery">
<MemberSignature Language="C#" Value="public int ExecuteNonQuery (Gda.Command cmd, Gda.ParameterList parms);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cmd" Type="Gda.Command" />
<Parameter Name="parms" Type="Gda.ParameterList" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cmd">a <see cref="T:Gda.Command" /></param>
<param name="parms">a <see cref="T:Gda.ParameterList" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ChangeDatabase">
<MemberSignature Language="C#" Value="public bool ChangeDatabase (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DropDatabase">
<MemberSignature Language="C#" Value="public bool DropDatabase (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AddErrorList">
<MemberSignature Language="C#" Value="public void AddErrorList (GLib.List error_list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="error_list" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="error_list">a <see cref="T:GLib.List" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CommitTransaction">
<MemberSignature Language="C#" Value="public bool CommitTransaction (Gda.Transaction xaction);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="xaction" Type="Gda.Transaction" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="xaction">a <see cref="T:Gda.Transaction" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AddError">
<MemberSignature Language="C#" Value="public void AddError (Gda.Error error);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="error" Type="Gda.Error" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="error">a <see cref="T:Gda.Error" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateDatabase">
<MemberSignature Language="C#" Value="public bool CreateDatabase (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Supports">
<MemberSignature Language="C#" Value="public bool Supports (Gda.ConnectionFeature feature);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="feature" Type="Gda.ConnectionFeature" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="feature">a <see cref="T:Gda.ConnectionFeature" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ExecuteSingleCommand">
<MemberSignature Language="C#" Value="public Gda.DataModel ExecuteSingleCommand (Gda.Command cmd, Gda.ParameterList parms);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gda.DataModel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cmd" Type="Gda.Command" />
<Parameter Name="parms" Type="Gda.ParameterList" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cmd">a <see cref="T:Gda.Command" /></param>
<param name="parms">a <see cref="T:Gda.ParameterList" /></param>
<returns>a <see cref="T:Gda.DataModel" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public bool Close ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ExecuteCommand">
<MemberSignature Language="C#" Value="public GLib.List ExecuteCommand (Gda.Command cmd, Gda.ParameterList parms);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cmd" Type="Gda.Command" />
<Parameter Name="parms" Type="Gda.ParameterList" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cmd">a <see cref="T:Gda.Command" /></param>
<param name="parms">a <see cref="T:Gda.ParameterList" /></param>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSchema">
<MemberSignature Language="C#" Value="public Gda.DataModel GetSchema (Gda.ConnectionSchema schema, Gda.ParameterList parms);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gda.DataModel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="schema" Type="Gda.ConnectionSchema" />
<Parameter Name="parms" Type="Gda.ParameterList" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="schema">a <see cref="T:Gda.ConnectionSchema" /></param>
<param name="parms">a <see cref="T:Gda.ParameterList" /></param>
<returns>a <see cref="T:Gda.DataModel" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateBlob">
<MemberSignature Language="C#" Value="public bool CreateBlob (Gda.Blob blob);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="blob" Type="Gda.Blob" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="blob">a <see cref="T:Gda.Blob" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Connection (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.Connection" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Connection (Gda.Client client, Gda.ServerProvider provider, string dsn, string username, string password, Gda.ConnectionOptions options);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="client" Type="Gda.Client" />
<Parameter Name="provider" Type="Gda.ServerProvider" />
<Parameter Name="dsn" Type="System.String" />
<Parameter Name="username" Type="System.String" />
<Parameter Name="password" Type="System.String" />
<Parameter Name="options" Type="Gda.ConnectionOptions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="client">a <see cref="T:Gda.Client" /></param>
<param name="provider">a <see cref="T:Gda.ServerProvider" /></param>
<param name="dsn">a <see cref="T:System.String" /></param>
<param name="username">a <see cref="T:System.String" /></param>
<param name="password">a <see cref="T:System.String" /></param>
<param name="options">a <see cref="T:Gda.ConnectionOptions" /></param>
<returns>a <see cref="T:Gda.Connection" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CncString">
<MemberSignature Language="C#" Value="public string CncString { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Errors">
<MemberSignature Language="C#" Value="public GLib.List Errors { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Options">
<MemberSignature Language="C#" Value="public Gda.ConnectionOptions Options { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gda.ConnectionOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gda.ConnectionOptions" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Dsn">
<MemberSignature Language="C#" Value="public string Dsn { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Database">
<MemberSignature Language="C#" Value="public string Database { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Username">
<MemberSignature Language="C#" Value="public string Username { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Client">
<MemberSignature Language="C#" Value="public Gda.Client Client { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gda.Client</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gda.Client" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Password">
<MemberSignature Language="C#" Value="public string Password { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ServerVersion">
<MemberSignature Language="C#" Value="public string ServerVersion { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Provider">
<MemberSignature Language="C#" Value="public string Provider { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="public event Gda.ErrorHandler Error;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gda.ErrorHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsOpen">
<MemberSignature Language="C#" Value="public bool IsOpen { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></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.Connection" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnError">
<MemberSignature Language="C#" Value="protected virtual void OnError (GLib.List error_list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="error_list" Type="GLib.List" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gda.Connection.Error" /> event.</summary>
<param name="error_list">a <see cref="T:GLib.List" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.Connection.Error" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Connection (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.Connection" /></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>