Files
mono/mcs/class/System.Data/Documentation/en/System.Data.SqlClient/SqlConnection.xml
T
2008-10-17 14:11:42 +00:00

814 lines
37 KiB
XML
Executable File

<Type Name="SqlConnection" FullName="System.Data.SqlClient.SqlConnection">
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed class SqlConnection : System.Data.Common.DbConnection, ICloneable" />
<AssemblyInfo>
<AssemblyName>System.Data</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.Data.Common.DbConnection</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultEvent("InfoMessage")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>The SqlConnection class represents a SQL Server connection.</summary>
<remarks>When a previously opened SQLConnection goes out of scope, the database connection is not automatically closed. Connections that have been opened must be explicitly closed by calling either Close or Dispose.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SqlConnection ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Initializes a new instance of the SqlConnection class.</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SqlConnection (string connectionString);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
</Parameters>
<Docs>
<param name="connectionString">
<para>A <see cref="T:System.String" /> value consisting of the desired database connection string.
</para>
<para>See <see cref="P:System.Data.SqlClient.SqlConnection.ConnectionString" /> for more information.
</para>
</param>
<summary>Initializes a new instance of the SqlConnection class with a connection string.</summary>
<remarks>Providing a connection string to the SQLConnection constructor does not implicitly open a connection to a database.</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BeginDbTransaction">
<MemberSignature Language="C#" Value="protected override System.Data.Common.DbTransaction BeginDbTransaction (System.Data.IsolationLevel isolationLevel);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.Common.DbTransaction</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="isolationLevel" Type="System.Data.IsolationLevel" />
</Parameters>
<Docs>
<param name="isolationLevel">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BeginTransaction">
<MemberSignature Language="C#" Value="public System.Data.SqlClient.SqlTransaction BeginTransaction ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlTransaction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Begins a new database transaction.</summary>
<returns>A new instance of the <see cref="T:System.Data.SqlClient.SqlTransaction" /> class that references the current <see cref="T:System.Data.SqlClient.SqlConnection" /> instance.</returns>
<remarks>
<para>
Creates and initializes a new <see cref="T:System.Data.SqlClient.SqlTransaction" /> instance associated with the current <see cref="T:System.Data.SqlClient.SqlConnection" />.
</para>
<para>The new transaction is created with a default <see cref="T:System.Data.IsolationLevel" /> of <see cref="F:System.Data.IsolationLevel.ReadCommitted" /> and an empty transaction name.</para>
<para>The <see cref="T:System.Data.SqlClient.SqlConnection" /> class only supports a single transaction. The creation of more will raise an InvalidOperationException exception.
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BeginTransaction">
<MemberSignature Language="C#" Value="public System.Data.SqlClient.SqlTransaction BeginTransaction (System.Data.IsolationLevel iso);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlTransaction</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iso" Type="System.Data.IsolationLevel" />
</Parameters>
<Docs>
<param name="iso">An <see cref="T:System.Data.IsolationLevel" /> to initialize the transaction with.</param>
<summary>Begins a new database transaction with a specified <see cref="T:System.Data.IsolationLevel" />.</summary>
<returns>A new instance of the <see cref="T:System.Data.SqlClient.SqlTransaction" /> class that references the current <see cref="T:System.Data.SqlClient.SqlConnection" /> instance.</returns>
<remarks>
<para>
Creates and initializes a new <see cref="T:System.Data.SqlClient.SqlTransaction" /> instance associated with the current <see cref="T:System.Data.SqlClient.SqlConnection" />.
</para>
<para>The new transaction is created with an <see cref="T:System.Data.IsolationLevel" /> of the desired isolation level and an empty transaction name.</para>
<para>The <see cref="T:System.Data.SqlClient.SqlConnection" /> class only supports a single transaction. The creation of more will raise an InvalidOperationException exception.
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BeginTransaction">
<MemberSignature Language="C#" Value="public System.Data.SqlClient.SqlTransaction BeginTransaction (string transactionName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlTransaction</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="transactionName" Type="System.String" />
</Parameters>
<Docs>
<param name="transactionName">A <see cref="T:System.String" /> value representing the desired transaction name.</param>
<summary>Begins a new database transaction with a specified transaction name.</summary>
<returns>A new instance of the <see cref="T:System.Data.SqlClient.SqlTransaction" /> class that references the current <see cref="T:System.Data.SqlClient.SqlConnection" /> instance.</returns>
<remarks>
<para>
Creates and initializes a new <see cref="T:System.Data.SqlClient.SqlTransaction" /> instance associated with the current <see cref="T:System.Data.SqlClient.SqlConnection" />.
</para>
<para>The new transaction is created with a default <see cref="T:System.Data.IsolationLevel" /> of <see cref="F:System.Data.IsolationLevel.ReadCommitted" /> and a transaction name value provided by the transactionName parameter.</para>
<para>The <see cref="T:System.Data.SqlClient.SqlConnection" /> class only supports a single transaction. The creation of more will raise an InvalidOperationException exception.
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BeginTransaction">
<MemberSignature Language="C#" Value="public System.Data.SqlClient.SqlTransaction BeginTransaction (System.Data.IsolationLevel iso, string transactionName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlTransaction</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iso" Type="System.Data.IsolationLevel" />
<Parameter Name="transactionName" Type="System.String" />
</Parameters>
<Docs>
<param name="iso">An <see cref="T:System.Data.IsolationLevel" /> to initialize the transaction with.</param>
<param name="transactionName">A <see cref="T:System.String" /> value representing the desired transaction name.</param>
<summary>Begins a new database transaction with a specified <see cref="T:System.Data.IsolationLevel" /> and transaction name.</summary>
<returns>A new instance of the <see cref="T:System.Data.SqlClient.SqlTransaction" /> class that references the current <see cref="T:System.Data.SqlClient.SqlConnection" /> instance.</returns>
<remarks>
<para>
Creates and initializes a new <see cref="T:System.Data.SqlClient.SqlTransaction" /> instance associated with the current <see cref="T:System.Data.SqlClient.SqlConnection" />.
</para>
<para>The new transaction is created using the provided <see cref="T:System.Data.IsolationLevel" /> and transaction name.</para>
<para>The <see cref="T:System.Data.SqlClient.SqlConnection" /> class only supports a single transaction. The creation of more will raise an InvalidOperationException exception.
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChangeDatabase">
<MemberSignature Language="C#" Value="public override void ChangeDatabase (string database);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="database" Type="System.String" />
</Parameters>
<Docs>
<param name="database">The name of an existing database to associate the <see cref="T:System.Data.SqlClient.SqlConnection" /> instance with.</param>
<summary>Change the database currently associated with the <see cref="T:System.Data.SqlClient.SqlConnection" /> instance.</summary>
<remarks>Change the database currently associated with the <see cref="T:System.Data.SqlClient.SqlConnection" /> instance. The SqlConnection instance must already be connected to a SQL Server database.</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChangePassword">
<MemberSignature Language="C#" Value="public static void ChangePassword (string connectionString, string newPassword);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
<Parameter Name="newPassword" Type="System.String" />
</Parameters>
<Docs>
<param name="connectionString">To be added.</param>
<param name="newPassword">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClearAllPools">
<MemberSignature Language="C#" Value="public static void ClearAllPools ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClearPool">
<MemberSignature Language="C#" Value="public static void ClearPool (System.Data.SqlClient.SqlConnection connection);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="connection" Type="System.Data.SqlClient.SqlConnection" />
</Parameters>
<Docs>
<param name="connection">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public override void Close ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Close an open database connection.</summary>
<remarks>Calling this method closes a connection to a SQL Server or releases the connection back to the connection pool. The <see cref="T:System.Data.SqlClient.SqlConnection" /> state is set to closed.
<para>
Calling Close on a <see cref="T:System.Data.SqlClient.SqlConnection" /> instance that is not currently open is acceptable; no exception is raised.
</para><para>
If there are any pending transactions, they will be rolled back.
</para></remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ConnectionString">
<MemberSignature Language="C#" Value="public override string ConnectionString { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Gets or sets the database Connection String associated with the SqlConnection instance.</summary>
<value>The current connection string.</value>
<remarks>
<para>
The Connection String is a <see cref="T:System.String" /> value that describes how to connect to a SQL Server instance. The Connection String is composed of a series of name/value pairs connected by equal signs and separated by semicolons.
</para>
<para>
The SQL Server Connection String should consist of at least the following:
<list type="bullet"><item><term>Data Source or Server</term></item><item><term>Database or Initial Catalog</term></item></list></para>
<para>
The following illustrates a simple SQL Server Connection String that describes a connection to a database called pubs on the local machine as a user called username with a password of mypassword:
<example><code lang="SQL Server Connection String">
"Server=localhost;Database=pubs;Uid=username;Password=mypassword"
</code></example></para>
<block subset="none" type="note">The Connection String can not be set when a connection to a database is already open.</block>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.RecommendedAsConfigurable(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Editor("Microsoft.VSDesigner.Data.SQL.Design.SqlConnectionStringEditor, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="ConnectionTimeout">
<MemberSignature Language="C#" Value="public override int ConnectionTimeout { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the amount of time the <see cref="T:System.Data.SqlClient.SqlConnection" /> will wait while attempting to connect to a SQL Server instance.</summary>
<value>The amount of time (in seconds) the SqlConnection will wait when attempting to connect.</value>
<remarks>
<para>The connection timeout is a <see cref="T:System.Integer" /> value indicating the amount of time, in seconds, the SqlConnection will wait while attempting to connect to a SQL Server instance.
</para>
<para>The default timeout is 15 seconds.
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="CreateCommand">
<MemberSignature Language="C#" Value="public System.Data.SqlClient.SqlCommand CreateCommand ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlCommand</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a new instance of the <see cref="T:System.Data.SqlClient.SqlCommand" /> class with the connection referencing the current <see cref="T:System.Data.SqlClient.SqlCommand" /> instance.</summary>
<returns>A new instance of the <see cref="T:System.Data.SqlClient.SqlCommand" /> class.</returns>
<remarks>
<para>Creates a new instance of the <see cref="T:System.Data.SqlClient.SqlCommand" /> class with the connection referencing the current <see cref="T:System.Data.SqlClient.SqlCommand" /> instance.</para>
<para>The returned <see cref="T:System.Data.SqlClient.SqlCommand" /> instance can be used to execute T-SQL statements or stored procedures against the current database connection.</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateDbCommand">
<MemberSignature Language="C#" Value="protected override System.Data.Common.DbCommand CreateDbCommand ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.Common.DbCommand</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Database">
<MemberSignature Language="C#" Value="public override string Database { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of the database the <see cref="T:System.Data.SqlClient.SqlConnection" /> instance references.</summary>
<value>Gets a <see cref="T:System.String" /> value representing the current SQL Server database.</value>
<remarks>Gets the name of the current database an open <see cref="T:System.Data.SqlClient.SqlConnection" /> is currently connected to.
<para>
The <see cref="P:System.Data.SqlClient.SqlConnection.Database" /> is set in the Connection String by supplying either a "database" or "initial catalog" value.
</para><block subset="none" type="note">The Database property can only be set when the <see cref="T:System.Data.SqlClient.SqlConnection" /> has an open connection to a SQL Server.</block></remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="DataSource">
<MemberSignature Language="C#" Value="public override string DataSource { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current SQL Server that the <see cref="T:System.Data.SqlClient.SqlConnection" /> references.</summary>
<value>Gets a <see cref="T:System.String" /> value representing the current SQL Server instance.</value>
<remarks>
<para>
Gets the current DataSource the <see cref="T:System.Data.SqlClient.SqlConnection" /> instance references. The DataSource is the SQL Server network address and (optionally) data port.
</para>
<para>
The <see cref="P:System.Data.SqlClient.SqlConnection.DataSource" /> can be set in the Connection String by denoting it with one of the following key names: "data source", "server", "address", "addr", or "network address".
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Browsable(true)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">To be added: an object of type 'bool'</param>
<summary>Disposes the current <see cref="T:System.Data.SqlClient.SqlConnection" /> instance.</summary>
<remarks>
<para>
Disposes the current <see cref="T:System.Data.SqlClient.SqlConnection" /> instance.
</para>
<para>
Disposing this class will close the current connection, if one is active.
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EnlistDistributedTransaction">
<MemberSignature Language="C#" Value="public void EnlistDistributedTransaction (System.EnterpriseServices.ITransaction transaction);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="transaction" Type="System.EnterpriseServices.ITransaction" />
</Parameters>
<Docs>
<param name="transaction">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FireInfoMessageEventOnUserErrors">
<MemberSignature Language="C#" Value="public bool FireInfoMessageEventOnUserErrors { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSchema">
<MemberSignature Language="C#" Value="public override System.Data.DataTable GetSchema ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.DataTable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSchema">
<MemberSignature Language="C#" Value="public override System.Data.DataTable GetSchema (string collectionName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.DataTable</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="collectionName" Type="System.String" />
</Parameters>
<Docs>
<param name="collectionName">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSchema">
<MemberSignature Language="C#" Value="public override System.Data.DataTable GetSchema (string collectionName, string[] restrictionValues);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.DataTable</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="collectionName" Type="System.String" />
<Parameter Name="restrictionValues" Type="System.String[]" />
</Parameters>
<Docs>
<param name="collectionName">To be added.</param>
<param name="restrictionValues">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InfoMessage">
<MemberSignature Language="C#" Value="public event System.Data.SqlClient.SqlInfoMessageEventHandler InfoMessage;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlInfoMessageEventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public override void Open ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Opens a connection to a SQL Server database.</summary>
<remarks>
<para>This method opens a new connection (or obtains an existing one from the connection pool) to a SQL Server database using a previously provided connection string.</para>
<para>A SqlException will be thrown if the connection is closed and any commands are executed against the SQL server.
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PacketSize">
<MemberSignature Language="C#" Value="public int PacketSize { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the packet size used to communicate with a SQL Server.</summary>
<value>The packet size, in bytes.</value>
<remarks>
<para>Gets the packet size used to communicate with a SQL Server over a network.
</para>
<para>
The <see cref="P:System.Data.SqlClient.SqlConnection.PacketSize" /> can be set by appending the "packet size" value to the Connection String.
</para>
<para>
<block subset="none" type="note">The default packet size is 8192 bytes.
</block>
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="ServerVersion">
<MemberSignature Language="C#" Value="public override string ServerVersion { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the version of a SQL Server instance.</summary>
<value>A <see cref="T:System.String" /> value representing the version of the currently connected SQL Server instance.</value>
<remarks>Gets the version of the SQL Server instance the <see cref="T:System.Data.SqlClient.SqlConnection" /> is currently connected to.</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public override System.Data.ConnectionState State { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Data.ConnectionState</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current connection state.</summary>
<value>The current connection state, represented by an instance of the <see cref="T:System.Data.ConnectionState" /> enum.</value>
<remarks>Gets the current connection state on the <see cref="T:System.Data.SqlClient.SqlConnection" /> instance. This value indicates whether the connection is open or closed.</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="StateChange">
<MemberSignature Language="C#" Value="public event System.Data.StateChangeEventHandler StateChange;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.Data.StateChangeEventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Event that is triggered when the connection's status changes.</summary>
<remarks>This event is triggered when the <see cref="T:System.Data.SqlClient.SqlConnection" /> connection status changes to open or closed.</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Data.DataSysDescription(Description="Event triggered when the connection changes state.")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="StatisticsEnabled">
<MemberSignature Language="C#" Value="public bool StatisticsEnabled { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Data.IDbConnection.BeginTransaction">
<MemberSignature Language="C#" Value="System.Data.IDbTransaction IDbConnection.BeginTransaction ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.IDbTransaction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Data.IDbConnection.BeginTransaction">
<MemberSignature Language="C#" Value="System.Data.IDbTransaction IDbConnection.BeginTransaction (System.Data.IsolationLevel iso);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.IDbTransaction</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iso" Type="System.Data.IsolationLevel" />
</Parameters>
<Docs>
<param name="iso">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Data.IDbConnection.CreateCommand">
<MemberSignature Language="C#" Value="System.Data.IDbCommand IDbConnection.CreateCommand ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.IDbCommand</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.ICloneable.Clone">
<MemberSignature Language="C#" Value="object ICloneable.Clone ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WorkstationId">
<MemberSignature Language="C#" Value="public string WorkstationId { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the database connection client workstation ID.</summary>
<value>A <see cref="T:System.String" /> value representing the connection's network client.</value>
<remarks>
<para>Returns an ID that represents the database connection's network client.</para>
<para>
<see cref="P:System.Data.SqlClient.SqlConnection.Workstationid" /> can be set by appending a "workstatation id" value to the Connection String.
</para>
</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
</Attributes>
</Member>
</Members>
</Type>