Update of /cvsroot/firebird/Net-Provider/source/xmldoc
In directory sc8-pr-cvs1:/tmp/cvs-serv498
Modified Files:
fbcommandbuilder.xml fbconnection.xml fbdataadapter.xml
fbdatareader.xml
Log Message:
Updated external documentation files
Index: fbcommandbuilder.xml
===================================================================
RCS file: /cvsroot/firebird/Net-Provider/source/xmldoc/fbcommandbuilder.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -b -U3 -r1.8 -r1.9
--- fbcommandbuilder.xml 25 Nov 2002 18:18:26 -0000 1.8
+++ fbcommandbuilder.xml 26 Nov 2002 11:00:31 -0000 1.9
@@ -26,13 +26,8 @@
<doc>
<member name="T:FbCommandBuilder">
<summary>
- <para>
Automatically generates single-table commands used to reconcile changes
- made to a DataSet with the associated data source.
- </para>
- <para>
- <b>This class cannot be inherited.</b>
- </para>
+ made to a DataSet with the associated data source. This class cannot be inherited.
</summary>
<remarks>
<para>
Index: fbconnection.xml
===================================================================
RCS file: /cvsroot/firebird/Net-Provider/source/xmldoc/fbconnection.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -b -U3 -r1.14 -r1.15
--- fbconnection.xml 25 Nov 2002 12:33:30 -0000 1.14
+++ fbconnection.xml 26 Nov 2002 11:00:32 -0000 1.15
@@ -105,6 +105,7 @@
FbTransaction myTxn = myConn.BeginTransaction();
string myInsertQuery = "INSERT INTO PROJECT(proj_id, proj_name, product) Values('FBNP', '.Net Provider', 'N/A')";
FbCommand myFbCommand = new FbCommand(myInsertQuery, myConn, myTxn);
+
myFbCommand.ExecuteNonQuery();
myConn.Close();
}
Index: fbdataadapter.xml
===================================================================
RCS file: /cvsroot/firebird/Net-Provider/source/xmldoc/fbdataadapter.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -b -U3 -r1.6 -r1.7
--- fbdataadapter.xml 18 Nov 2002 10:19:12 -0000 1.6
+++ fbdataadapter.xml 26 Nov 2002 11:00:33 -0000 1.7
@@ -31,8 +31,10 @@
This class cannot be inherited.
</summary>
<remarks>
+ </remarks>
<example>
<code>
+ <pre>
public static void CreateSqlDataAdapter()
{
FbConnection conn = new FbConnection("Database=C:\\PROGRAM FILES\\FIREBIRD\\EXAMPLES\\EMPLOYEE.GDB;User=SYSDBA;Password=masterkey;Dialect=3;Server=localhost");
@@ -57,9 +59,9 @@
custDA.DeleteCommand.Parameters.Add("@oldcustno", SqlDbType.Int32, 4, "custno").SourceVersion = DataRowVersion.Original;
}
+ </pre>
</code>
</example>
- </remarks>
</member>
<member name="F:EventRowUpdated">
<summary>
@@ -74,10 +76,10 @@
</member>
<member name="M:#ctor">
<summary>
- Initializes a new instance of the FbDataAdapter class.
+ Initializes a new instance of the <see cref="FbDataAdapter">FbDataAdapter</see> class.
</summary>
<remarks>
- When you create an instance of FbDataAdapter, the following read/write properties
+ When you create an instance of <see cref="FbDataAdapter">FbDataAdapter</see>, the following read/write properties
are set to their default values, as shown in the table.
<list type="table">
<listheader>
@@ -97,15 +99,15 @@
</member>
<member name="M:#ctor(FirebirdSql.Data.Firebird.FbCommand)">
<summary>
- Initializes a new instance of the FbDataAdapter class with the specified SQL SELECT
+ Initializes a new instance of the <see cref="FbDataAdapter">FbDataAdapter</see> class with the specified SQL SELECT
statement.
</summary>
<param name="selectCommand">
- An FbCommand that is an SQL SELECT statement or stored procedure, and is set as the
- SelectCommand property of the FbDataAdapter.
+ An <see cref="FbCommand">FbCommand</see> that is an SQL SELECT statement or stored procedure, and is set as the
+ <see cref="FbDataAdapter.SelectCommand">SelectCommand</see> property of the <see cref="FbDataAdapter">FbDataAdapter</see>.
</param>
<remarks>
- When you create an instance of FbDataAdapter, the following read/write properties
+ When you create an instance of <see cref="FbDataAdapter">FbDataAdapter</see>, the following read/write properties
are set to their default values, as shown in the table.
<list type="table">
<listheader>
@@ -125,18 +127,18 @@
</member>
<member name="M:#ctor(System.String,FirebirdSql.Data.Firebird.FbConnection)">
<summary>
- Initializes a new instance of the FbDataAdapter class with an SQL SELECT
- statement and an FbConnection.
+ Initializes a new instance of the <see cref="FbDataAdapter">FbDataAdapter</see> class with an SQL SELECT
+ statement and an <see cref="FbConnection">FbConnection</see>.
</summary>
<param name="selectCommandText">
A string that is a SQL SELECT statement or stored procedure to be used by the
- SelectCommand property of the FbDataAdapter.
+ <see cref="FbDataAdapter.SelectCommand">SelectCommand</see> property of the <see cref="FbDataAdapter">FbDataAdapter</see>.
</param>
<param name="selectConnection">
- An FbConnection that represents the connection.
+ An <see cref="FbConnection">FbConnection</see> that represents the connection.
</param>
<remarks>
- When you create an instance of FbDataAdapter, the following read/write properties
+ When you create an instance of <see cref="FbDataAdapter">FbDataAdapter</see>, the following read/write properties
are set to their default values, as shown in the table.
<list type="table">
<listheader>
@@ -156,18 +158,18 @@
</member>
<member name="M:#ctor(System.String,System.String)">
<summary>
- Initializes a new instance of the FbDataAdapter class with an SQL SELECT statement
+ Initializes a new instance of the <see cref="FbDataAdapter">FbDataAdapter</see> class with an SQL SELECT statement
and a connection string.
</summary>
<param name="selectCommandText">
A string that is a SQL SELECT statement or stored procedure to be used by the
- SelectCommand property of the FbDataAdapter.
+ <see cref="FbDataAdapter.SelectCommand">SelectCommand</see> property of the <see cref="FbDataAdapter">FbDataAdapter</see>.
</param>
<param name="selectConnectionString">
The connection string.
</param>
<remarks>
- When you create an instance of FbDataAdapter, the following read/write properties
+ When you create an instance of <see cref="FbDataAdapter">FbDataAdapter</see>, the following read/write properties
are set to their default values, as shown in the table.
<list type="table">
<listheader>
@@ -190,7 +192,7 @@
Initializes a new instance of the RowUpdatedEventArgs class, regardless of whether the update is successful.
</summary>
<param name="dataRow">The DataRow used to update the data source. </param>
- <param name="command">The FbCommand executed during the update operation. </param>
+ <param name="command">The <see cref="FbCommand">FbCommand</see> executed during the update operation. </param>
<param name="statementType">Whether the command is an UPDATE, INSERT, DELETE, or SELECT statement. </param>
<param name="tableMapping"> DataTableMapping object. </param>
<returns>A new instance of the System.Data.Common.RowUpdatedEventArgs class.</returns>
@@ -198,7 +200,7 @@
<member name="M:CreateRowUpdatingEvent(System.Data.DataRow,System.Data.IDbCommand,System.Data.StatementType,System.Data.Common.DataTableMapping)">
<summary>Initializes a new instance of the RowUpdatingEventArgs class.</summary>
<param name="dataRow">The DataRow used to update the data source. </param>
- <param name="command">The FbCommand executed during the update operation. </param>
+ <param name="command">The <see cref="FbCommand">FbCommand</see> executed during the update operation. </param>
<param name="statementType">Whether the command is an UPDATE, INSERT, DELETE, or SELECT statement. </param>
<param name="tableMapping"> DataTableMapping object. </param>
<returns>A new instance of the System.Data.Common.RowUpdatingEventArgs class.</returns>
@@ -225,7 +227,7 @@
in the data source.
</summary>
<value>
- An FbCommand that is used during a fill operation to select records from
+ An <see cref="FbCommand">FbCommand</see> that is used during a fill operation to select records from
data source for placement in the DataSet.
</value>
</member>
@@ -235,7 +237,7 @@
the data source.
</summary>
<value>
- An FbCommand that is used during a fill operation to select records from
+ An <see cref="FbCommand">FbCommand</see> that is used during a fill operation to select records from
data source for placement in the DataSet.
</value>
</member>
@@ -245,7 +247,7 @@
insert new records into the data source.
</summary>
<value>
- An FbCommand used during an update operation to insert records in
+ An <see cref="FbCommand">FbCommand</see> used during an update operation to insert records in
the data source that correspond to new rows in the DataSet.
</value>
</member>
@@ -255,7 +257,7 @@
insert new records into the data source.
</summary>
<value>
- An FbCommand used during an update operation to insert records in
+ An <see cref="FbCommand">FbCommand</see> used during an update operation to insert records in
the data source that correspond to new rows in the DataSet.
</value>
</member>
@@ -265,7 +267,7 @@
in the data source.
</summary>
<value>
- An FbCommand used during an update operation to update records in the
+ An <see cref="FbCommand">FbCommand</see> used during an update operation to update records in the
data source that correspond to modified rows in the DataSet.
</value>
</member>
@@ -275,7 +277,7 @@
in the data source.
</summary>
<value>
- An FbCommand used during an update operation to update records in the
+ An <see cref="FbCommand">FbCommand</see> used during an update operation to update records in the
data source that correspond to modified rows in the DataSet.
</value>
</member>
@@ -285,7 +287,7 @@
in the data source.
</summary>
<value>
- An FbCommand used during an update operation to delete records in the
+ An <see cref="FbCommand">FbCommand</see> used during an update operation to delete records in the
data source that correspond to deleted rows in the DataSet.
</value>
</member>
@@ -295,7 +297,7 @@
in the data source.
</summary>
<value>
- An FbCommand used during an update operation to delete records in the
+ An <see cref="FbCommand">FbCommand</see> used during an update operation to delete records in the
data source that correspond to deleted rows in the DataSet.
</value>
</member>
@@ -312,14 +314,14 @@
</member>
<member name="T:FbRowUpdatingEventHandler">
<summary>
- Represents the method that will handle the RowUpdating event of an FbDataAdapter.
+ Represents the method that will handle the RowUpdating event of an <see cref="FbDataAdapter">FbDataAdapter</see>.
</summary>
<param name="sender">The source of the event. </param>
<param name="e">The FbRowUpdatingEventArgs that contains the event data. </param>
</member>
<member name="T:FbRowUpdatedEventHandler">
<summary>
- Represents the method that will handle the RowUpdated event of an FbDataAdapter.
+ Represents the method that will handle the RowUpdated event of an <see cref="FbDataAdapter">FbDataAdapter</see>.
</summary>
<param name="sender">The source of the event. </param>
<param name="e">The FbRowUpdatedEventArgs that contains the event data. </param>
Index: fbdatareader.xml
===================================================================
RCS file: /cvsroot/firebird/Net-Provider/source/xmldoc/fbdatareader.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -b -U3 -r1.6 -r1.7
--- fbdatareader.xml 22 Nov 2002 11:44:48 -0000 1.6
+++ fbdatareader.xml 26 Nov 2002 11:00:34 -0000 1.7
@@ -31,27 +31,28 @@
</summary>
<remarks>
<para>
- To create an FbDataReader, you must call the ExecuteReader
- method of the FbCommand object, rather than directly using a constructor.
+ To create an <b>FbDataReader</b>, you must call the <see cref="FbCommand.ExecuteReader">ExecuteReader</see>
+ method of the <see cref="FbCommand">FbCommand</see> object, rather than directly using a constructor.
</para>
<para>
- While the FbDataReader is in use, the associated FbConnection is
- busy serving the FbDataReader, and no other operations can be performed
- on the FbConnection other than closing it. This is the case until the
- Close method of the FbDataReader is called. For example, you cannot retrieve
- output parameters until after you call Close.
+ While the <b>FbDataReader</b> is in use, the associated <see cref="FbConnection">FbConnection</see> is
+ busy serving the <b>FbDataReader</b>, and no other operations can be performed
+ on the <see cref="FbConnection">FbConnection</see> other than closing it. This is the case until the
+ <see cref="FbDataReader.Close">Close</see> method of the <b>FbDataReader</b> is called. For example, you cannot retrieve
+ output parameters until after you call <see cref="FbDataReader.Close">Close</see>.
</para>
<para>
- IsClosed and RecordsAffected are the only properties that you can call after the
- OdbcDataReader is closed. In some cases, you must call Close before you can call
- RecordsAffected.
+ <see cref="FbDataReader.IsClosed">IsClosed</see> and <see cref="FbDataReader.RecordsAffected">RecordsAffected</see>
+ are the only properties that you can call after the <b>FbDataReader</b> is closed. In some cases,
+ you must call <see cref="FbDataReader.Close">Close</see> before you can call
+ <see cref="FbDataReader.RecordsAffected">RecordsAffected</see>.
</para>
</remarks>
<example>
- The following example creates an FbConnection, an FbCommand, and
- an FbDataReader. The example reads through the data, writing it out to
- the console. Finally, the example closes the FbDataReader, then the
- FbConnection.
+ The following example creates an <see cref="FbConnection">FbConnection</see>, an <see cref="FbCommand">FbCommand</see>, and
+ an <b>FbDataReader</b>. The example reads through the data, writing it out to
+ the console. Finally, the example closes the <b>FbDataReader</b>, then the
+ <see cref="FbConnection">FbConnection</see>.
<code>
public void ReadMyData(string myConnString)
{
@@ -83,40 +84,234 @@
</member>
<member name="M:#ctor(FirebirdSql.Data.Firebird.FbCommand,FirebirdSql.Data.Firebird.FbConnection)">
<summary>
- Initializes a new instance of the FbDataReader class.
+ Initializes a new instance of the <see cref="FbDataReader">FbDataReader</see> class.
</summary>
- <param name="command">A FbCommand object</param>
- <param name="connection">A FbConnection object</param>
+ <param name="command">A <see cref="FbCommand">FbCommand</see> object</param>
+ <param name="connection">A <see cref="FbDataReader">FbConnection</see> object</param>
</member>
<member name="M:Dispose">
<summary>
- Releases the unmanaged resources used by the FbDataReader and optionally
+ Releases the unmanaged resources used by the <see cref="FbDataReader">FbDataReader</see> and optionally
releases the managed resources.
</summary>
</member>
<member name="M:Close">
<summary>
- Closes the FbDataReader object.
+ Closes the <see cref="FbDataReader">FbDataReader</see> object.
</summary>
+ <remarks>
+ <para>
+ You must explicitly call the <b>Close</b> method when you are through
+ using the the <see cref="FbDataReader">FbDataReader</see> to use the associated
+ <see cref="FbConnection">FbConnection</see> for any other purpose.
+ </para>
+ <para>
+ The <b>Close</b> method fills in the values for output parameters, return
+ values and <b>RecordsAffected</b>, increasing the amount of time it takes to
+ close a <b>FbDataReader</b> that was used to process a large or complicated query.
+ In cases where the return values and the number of records affected by a query are not
+ significant, the amount of time it takes to close the <b>FbDataReader</b> can be
+ reduced by calling the <see cref="FbCommand.Cancel">Cancel</see> method of the associated
+ <see cref="FbCommand">FbCommand</see> object before calling the <b>Close</b> method.
+ </para>
+ </remarks>
</member>
<member name="M:NextResult">
<summary>
Advances the data reader to the next result,
when reading the results of batch DSQL statements.
</summary>
- <returns>true if there are more result sets; otherwise, false.</returns>
+ <returns><b>true</b> if there are more result sets; otherwise, <b>false</b>.</returns>
+ <remarks>
+ <para>
+ Used to process multiple results, which can be generated by executing batch
+ DSQL statements.
+ </para>
+ <para>
+ By default, the data reader is positioned on the first result.
+ </para>
+ </remarks>
</member>
<member name="M:Read">
<summary>
- Advances the FbDataReader to the next record.
+ Advances the <see cref="FbDataReader">FbDataReader</see> to the next record.
</summary>
- <returns>true if there are more rows; otherwise, false.</returns>
+ <returns><b>true</b> if there are more rows; otherwise, <b>false</b>.</returns>
+ <remarks>
+ <para>
+ The default position of the <see cref="FbDataReader">FbDataReader</see> is prior
+ to the first record. Therefore, you must call <b>Read</b> to begin accessing any
+ data.
+ </para>
+ <para>
+ Only one <b>FbDataReader</b> per associated <see cref="FbConnection">FbConnection</see>
+ may be open at a time, and any attempt to open another will fail until the first
+ one is closed. Similarly, while the <b>FbDataReader</b> is in use, the associated
+ <b>FbConnection</b> is busy serving it until you call <see cref="FbDataReader.Close">Close</see>.
+ </para>
+ </remarks>
</member>
<member name="M:GetSchemaTable">
<summary>
Returns a DataTable that describes the column metadata of the FbDataReader.
</summary>
- <returns></returns>
+ <returns>A DataTable that describes the column metadata.</returns>
+ <exception cref="InvalidOperationException">
+ The <see cref="FbDataReader">FbDataReader</see> is closed.
+ </exception>
+ <remarks>
+ <list type="table">
+ <listheader>
+ <term>DataReader Column</term>
+ <term>Description</term>
+ </listheader>
+ <item>
+ <description>ColumnName</description>
+ <description>
+ The name of the column; this might not be unique. If this cannot be
+ determined, a null value is returned. This name always reflects the
+ most recent renaming of the column in the current view or command text.
+ </description>
+ </item>
+ <item>
+ <description>ColumnOrdinal</description>
+ <description>
+ The ordinal of the column. This is zero for the bookmark column of the
+ row, if any. Other columns are numbered starting with one. This column
+ cannot contain a null value.
+ </description>
+ </item>
+ <item>
+ <description>ColumnSize</description>
+ <description>
+ The maximum possible length of a value in the column. For columns that
+ use a fixed-length data type, this is the size of the data type.
+ </description>
+ </item>
+ <item>
+ <description>NumericPrecision</description>
+ <description>
+ If ProviderType is a numeric data type, this is the maximum precision
+ of the column. The precision depends on the definition of the column.
+ If ProviderType is not a numeric data type, this is a null value.
+ </description>
+ </item>
+ <item>
+ <description>NumericScale</description>
+ <description>
+ If ProviderType is is DECIMAL or NUMERIC,
+ the number of digits to the right of the decimal point. Otherwise, this
+ is a null value.
+ </description>
+ </item>
+ <item>
+ <description>DataType</description>
+ <description>Maps to the .Net Framework type of the column.</description>
+ </item>
+ <item>
+ <description>ProviderType</description>
+ <description>
+ The indicator of the column's data type. If the data
+ type of the column varies from row to row, this must be Object. This
+ column cannot contain a null value.
+ </description>
+ </item>
+ <item>
+ <description>IsLong</description>
+ <description>
+ Set if the column contains a Binary Long Object (BLOB) that contains
+ very long data. The definition of very long data is provider-specific.
+ </description>
+ </item>
+ <item>
+ <description>AllowDbNull</description>
+ <description>
+ Set if the consumer can set the column to a null value
+ or if the provider cannot determine whether or not the consumer can set
+ the column to a null value. Otherwise, not set. A column may contain
+ null values, even if it cannot be set to a null value.
+ </description>
+ </item>
+ <item>
+ <description>IsReadOnly</description>
+ <description><b>true</b> if the column can be modified; otherwise <b>false</b>.</description>
+ </item>
+ <item>
+ <description>IsRowVersion</description>
+ <description>
+ Set if the column contains a persistent row identifier
+ that cannot be written to, and has no meaningful value except to
+ identity the row.
+ </description>
+ </item>
+ <item>
+ <description>IsUnique</description>
+ <description>
+ <b>true</b>: No two rows in the base table-the table returned in
+ BaseTableName-can have the same value in this column. IsUnique is
+ guaranteed to be <b>true</b> if the column constitutes a key by itself
+ or if there is a constraint of type UNIQUE that applies only to this column.
+ <b>false</b>: The column can contain duplicate values in the base table.The
+ default of this column is <b>false</b>.
+ </description>
+ </item>
+ <item>
+ <description>IsKey</description>
+ <description>
+ <b>true</b>: The column is one of a set of columns in
+ the rowset that, taken together, uniquely identify the row. The set of
+ columns with IsKey set to <b>true</b> must uniquely identify a row in
+ the rowset. There is no requirement that this set of columns is a
+ minimal set of columns. This set of columns may be generated from a
+ base table primary key, a unique constraint or a unique index.
+ <b>false</b>: The column is not required to uniquely identify the row.
+ </description>
+ </item>
+ <item>
+ <description>IsAutoIncrement</description>
+ <description>
+ <b>true</b>: The column assigns values to new rows in fixed
+ increments. <b>false</b>: The column does not assign values
+ to new rows in fixed increments.The default of this column is
+ <b>false</b>.
+ </description>
+ </item>
+ <item>
+ <description>BaseSchemaName</description>
+ <description>
+ The name of the schema in the data store that contains
+ the column. A null value if the base schema name cannot be determined.
+ The default of this column is a null value.
+ </description>
+ </item>
+ <item>
+ <description>BaseCatalogName</description>
+ <description>
+ The name of the catalog in the data store that contains
+ the column. NULL if the base catalog name cannot be determined. The
+ default of this column is a null value.
+ </description>
+ </item>
+ <item>
+ <description>BaseTableName</description>
+ <description>
+ The name of the table or view in the data store that contains the
+ column. A null value if the base table name cannot be determined. The
+ default of this column is a null value.
+ </description>
+ </item>
+ <item>
+ <description>BaseColumnName</description>
+ <description>
+ The name of the column in the data store. This might be different than
+ the column name returned in the ColumnName column if an alias was used.
+ A null value if the base column name cannot be determined or if the
+ rowset column is derived, but not identical to, a column in the data
+ store. The default of this column is a null value.
+ </description>
+ </item>
+ </list>
+ </remarks>
</member>
<member name="M:GetName(System.Int32)">
<summary>
|
