From 7d6721f192b1b99e10948b9a9327ef6c96fe99e2 Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Wed, 17 Jul 2019 19:26:50 -0700 Subject: [PATCH 01/14] Add API docs for System.Data.DataReaderExtensions --- xml/System.Data.Common/DbDataReader.xml | 125 ++----- xml/System.Data/DataReaderExtensions.xml | 396 ++++++++++++++++------- 2 files changed, 299 insertions(+), 222 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index da62b0f9b17..63f4d8e4c82 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -656,7 +656,7 @@ The zero-based column ordinal. - Returns a object for the requested column ordinal. + Returns a object for the requested column. A object. To be added. ADO.NET Overview @@ -724,7 +724,6 @@ private static void GetDataTypes(String connectionString) { ]]> - The specified cast is not valid. ADO.NET Overview @@ -1033,18 +1032,10 @@ private static void GetDataTypes(String connectionString) { - Synchronously gets the value of the specified column as a type. - The column to be retrieved. - Synchronously gets the value of the specified column as a type. - The column to be retrieved. - - - + The type of the value to be returned. + The zero-based column ordinal. + Synchronously gets the value of the specified column as the requested type. + The value of the specified column. The connection drops or is closed during the data retrieval. -or- @@ -1053,7 +1044,7 @@ private static void GetDataTypes(String connectionString) { -or- - There is no data ready to be read (for example, the first hasn't been called, or returned false). + There is no data ready to be read (for example, the first hasn't been called, or returned false). -or- @@ -1064,7 +1055,7 @@ private static void GetDataTypes(String connectionString) { There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. Trying to read a column that does not exist. - doesn't match the type returned by SQL Server or cannot be cast. + doesn't match the type returned by the database or cannot be cast. @@ -1073,15 +1064,7 @@ private static void GetDataTypes(String connectionString) { 4.1.0.0 - Asynchronously gets the value of the specified column as a type. - - - + Asynchronously gets the value of the specified column as the specified type. @@ -1120,26 +1103,9 @@ private static void GetDataTypes(String connectionString) { The type of the value to be returned. - The type of the value to be returned. - Asynchronously gets the value of the specified column as a type. - The type of the value to be returned. - - - + The zero-based column ordinal. + Asynchronously gets the value of the specified column as the requestsed type. + The value of the specified column. The connection drops or is closed during the data retrieval. -or- @@ -1198,27 +1164,10 @@ private static void GetDataTypes(String connectionString) { The type of the value to be returned. - The type of the value to be returned. - The cancellation instruction, which propagates a notification that operations should be canceled. This does not guarantee the cancellation. A setting of makes this method equivalent to . The returned task must be marked as cancelled. - Asynchronously gets the value of the specified column as a type. - The type of the value to be returned. - - - + The zero-based column ordinal. + An optional to cancel the asynchronous operation. + Asynchronously gets the value of the specified column as the requested type. + The value of the specified column. The connection drops or is closed during the data retrieval. -or- @@ -1611,7 +1560,7 @@ private static void GetCredits(String connectionString) { The zero-based column ordinal. - Returns the provider-specific field type of the specified column. + Gets the provider-specific type of the specified column. The object that describes the data type of the specified column. To be added. ADO.NET Overview @@ -1785,17 +1734,14 @@ private static void GetCredits(String connectionString) { - Retrieves data as a . - Retrieves data as a . - The returned object. + The zero-based column ordinal. + Gets a to retrieve data from the specified column. + A object. only supports the retrieval of values that can be converted to byte arrays. - - For more information, see [SqlClient Streaming Support](~/docs/framework/data/adonet/sqlclient-streaming-support.md). - ]]> The connection drops or is closed during the data retrieval. @@ -1895,17 +1841,14 @@ private static void GetCredits(String connectionString) { - Retrieves data as a . - Retrieves data as a . - The returned object. + The zero-based column ordinal. + Gets a to retrieve data from the column. + A object. only supports the retrieval of values that can be converted to character arrays (strings). - - For more information, see [SqlClient Streaming Support](~/docs/framework/data/adonet/sqlclient-streaming-support.md). - ]]> The connection drops or is closed during the data retrieval. @@ -2154,7 +2097,7 @@ private static void GetCredits(String connectionString) { 4.2.0.0 - An asynchronous version of , which gets a value that indicates whether the column contains non-existent or missing values. + Asynchronously gets a value that indicates whether the column contains non-existent or missing values. @@ -2190,17 +2133,9 @@ private static void GetCredits(String connectionString) { The zero-based column to be retrieved. - An asynchronous version of , which gets a value that indicates whether the column contains non-existent or missing values. + Asynchronously gets a value that indicates whether the column contains non-existent or missing values. if the specified column value is equivalent to otherwise . - - - The connection drops or is closed during the data retrieval. -or- @@ -2254,18 +2189,10 @@ private static void GetCredits(String connectionString) { The zero-based column to be retrieved. - The cancellation instruction, which propagates a notification that operations should be canceled. This does not guarantee the cancellation. A setting of makes this method equivalent to . The returned task must be marked as cancelled. - An asynchronous version of , which gets a value that indicates whether the column contains non-existent or missing values. Optionally, sends a notification that operations should be cancelled. + A System.Threading.CancellationToken to cancel the asynchronous operation." />. The returned task must be marked as cancelled. + Asynchronously gets a value that indicates whether the column contains non-existent or missing values. if the specified column value is equivalent to otherwise . - - - The connection drops or is closed during the data retrieval. -or- diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index 539d488564a..c2aeb70ae01 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -14,7 +14,7 @@ - To be added. + This class contains extension methods for . To be added. @@ -38,11 +38,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a Boolean. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -65,11 +67,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a byte. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -96,15 +100,17 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + The index within the row from which to begin the read operation. + The buffer into which to copy the data. + The index with the buffer to which the data will be copied. + The maximum number of characters to read. + Reads a stream of bytes from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . + The actual number of bytes read. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -127,11 +133,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a single character. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -158,15 +166,16 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + The index within the row from which to begin the read operation. + The buffer into which to copy the data. + The index with the buffer to which the data will be copied. + The maximum number of characters to read. + Reads a stream of characters from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . + The actual number of characters read. To be added. + ADO.NET Overview @@ -194,11 +203,12 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Returns a object for the requested column. + A object. To be added. + ADO.NET Overview @@ -221,11 +231,12 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets name of the data type of the specified column. + A string representing the name of the data type. To be added. + ADO.NET Overview @@ -248,11 +259,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a object. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -275,11 +288,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a object. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -302,11 +317,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a double-precision floating point number. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -329,11 +346,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the data type of the specified column. + The data type of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -359,12 +378,31 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to be returned. + The to get the column value from. + The name of the column. + Synchronously gets the value of the specified column as the requested type. + The value of the specified column. + The connection drops or is closed during the data retrieval. + +-or- + + The is closed during the data retrieval. + +-or- + + There is no data ready to be read (for example, the first hasn't been called, or returned false). + +-or- + + Tried to read a previously-read column in sequential mode. + +-or- + + There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. + Trying to read a column that does not exist. + + doesn't match the type returned by the database or cannot be cast. @@ -389,13 +427,30 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to be returned. + The to get the column value from. + The name of the column. + An optional to cancel the asynchronous operation. + Asynchronously gets the value of the specified column as the requestsed type. + The value of the specified column. + The connection drops or is closed during the data retrieval. + +-or- + + The is closed during the data retrieval. + +-or- + + There is no data ready to be read (for example, the first hasn't been called, or returned false). + +-or- + + Tried to read a previously-read column in sequential mode. + +-or- + + There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. + @@ -418,11 +473,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a single-precision floating point number. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -445,11 +502,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a globally-unique identifier (GUID). + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -472,11 +531,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a 16-bit signed integer. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -499,11 +560,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a 32-bit signed integer. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -526,11 +589,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as a 64-bit signed integer. + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -558,11 +623,12 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the provider-specific type of the specified column. + The object that describes the data type of the specified column. To be added. + ADO.NET Overview @@ -590,11 +656,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as an instance of . + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -617,11 +685,36 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets a to retrieve data from the specified column. + A object. + + only supports the retrieval of values that can be converted to byte arrays. + ]]> + + The connection drops or is closed during the data retrieval. + +-or- + + The is closed during the data retrieval. + +-or- + + There is no data ready to be read (for example, the first hasn't been called, or returned false). + +-or- + + Tried to read a previously-read column in sequential mode. + +-or- + + There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. + Trying to read a column that does not exist. + The specified column isn't a binary type that supports reading with a . @@ -644,11 +737,13 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as an instance of . + The value of the specified column. To be added. + The specified cast is not valid. + ADO.NET Overview @@ -671,11 +766,37 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets a to retrieve data from the column. + A object. + + only supports the retrieval of values that can be converted to character arrays (strings). + ]]> + + The connection drops or is closed during the data retrieval. + +-or- + + The is closed during the data retrieval. + +-or- + + There is no data ready to be read (for example, the first hasn't been called, or returned false). + +-or- + + Tried to read a previously-read column in sequential mode. + +-or- + + There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. + Trying to read a column that does not exist. + The specified column isn't a text type that supports reading with a . + @@ -698,11 +819,12 @@ - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets the value of the specified column as an instance of . + The value of the specified column. To be added. + ADO.NET Overview @@ -725,11 +847,20 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + Gets a value that indicates whether the column contains nonexistent or missing values. + + if the specified column is equivalent to ; otherwise . + + , , and so on) to avoid raising an error. + + ]]> + + ADO.NET Overview @@ -751,12 +882,31 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to get the column value from. + The name of the column. + A System.Threading.CancellationToken to cancel the asynchronous operation. + Asynchronously gets a value that indicates whether the column contains non-existent or missing values. + + if the specified column value is equivalent to otherwise . + + The connection drops or is closed during the data retrieval. + +-or- + + The is closed during the data retrieval. + +-or- + + There is no data ready to be read (for example, the first hasn't been called, or returned false). + +-or- + + Trying to read a previously read column in sequential mode. + +-or- + + There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. + Trying to read a column that does not exist. From 9499368275c1b1be8b2d9f7b5ba408f011b5a0ef Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Fri, 19 Jul 2019 15:49:29 -0700 Subject: [PATCH 02/14] Update xml/System.Data.Common/DbDataReader.xml Co-Authored-By: Ron Petrusha --- xml/System.Data.Common/DbDataReader.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 63f4d8e4c82..e59563172fc 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -1044,7 +1044,7 @@ private static void GetDataTypes(String connectionString) { -or- - There is no data ready to be read (for example, the first hasn't been called, or returned false). + There is no data ready to be read (for example, the first hasn't been called, or it returned ). -or- @@ -2834,4 +2834,4 @@ private static void GetCredits(String connectionString) { - \ No newline at end of file + From ffcafddf5b5d8bb9e6b194c26f219fdde9d5aee0 Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Fri, 19 Jul 2019 15:49:49 -0700 Subject: [PATCH 03/14] Update xml/System.Data.Common/DbDataReader.xml Co-Authored-By: Ron Petrusha --- xml/System.Data.Common/DbDataReader.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index e59563172fc..b07aa739cca 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -1104,7 +1104,7 @@ private static void GetDataTypes(String connectionString) { The type of the value to be returned. The zero-based column ordinal. - Asynchronously gets the value of the specified column as the requestsed type. + Asynchronously gets the value of the specified column as the requested type. The value of the specified column. The connection drops or is closed during the data retrieval. From 50cd2fff9e7cc95f3d933c1f495e302e11339088 Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Fri, 19 Jul 2019 16:11:50 -0700 Subject: [PATCH 04/14] Apply suggestions from code review Feedback from @rpetrusha. Thanks! Co-Authored-By: Ron Petrusha --- xml/System.Data.Common/DbDataReader.xml | 12 +++--- xml/System.Data/DataReaderExtensions.xml | 48 ++++++++++++------------ 2 files changed, 31 insertions(+), 29 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index b07aa739cca..348433f2e4a 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -1106,7 +1106,7 @@ private static void GetDataTypes(String connectionString) { The zero-based column ordinal. Asynchronously gets the value of the specified column as the requested type. The value of the specified column. - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during data retrieval. -or- @@ -1165,7 +1165,7 @@ private static void GetDataTypes(String connectionString) { The type of the value to be returned. The zero-based column ordinal. - An optional to cancel the asynchronous operation. + An optional token to cancel the asynchronous operation. Asynchronously gets the value of the specified column as the requested type. The value of the specified column. The connection drops or is closed during the data retrieval. @@ -1736,7 +1736,7 @@ private static void GetCredits(String connectionString) { The zero-based column ordinal. Gets a to retrieve data from the specified column. - A object. + A stream. The zero-based column ordinal. Gets a to retrieve data from the column. - A object. + A text reader. The zero-based column to be retrieved. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - if the specified column value is equivalent to otherwise . + if the specified column value is equivalent to ; otherwise, . The connection drops or is closed during the data retrieval. -or- @@ -2189,7 +2189,7 @@ private static void GetCredits(String connectionString) { The zero-based column to be retrieved. - A System.Threading.CancellationToken to cancel the asynchronous operation." />. The returned task must be marked as cancelled. + A cancellation token to cancel the asynchronous operation. The returned task must be marked as cancelled. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. if the specified column value is equivalent to otherwise . diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index c2aeb70ae01..ec3556c180e 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -14,7 +14,7 @@ - This class contains extension methods for . + Provides extension methods for . To be added. @@ -38,7 +38,7 @@ - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a Boolean. The value of the specified column. @@ -106,7 +106,9 @@ The buffer into which to copy the data. The index with the buffer to which the data will be copied. The maximum number of characters to read. - Reads a stream of bytes from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . + Reads a specified number of bytes from the specified column starting at a specified index and writes them to a buffer starting at a specified position in the buffer. + +Using parameter names in summary descriptions is discouraged since it makes the summary unclear in the member list, where parameter names don't appear. The actual number of bytes read. To be added. The specified cast is not valid. @@ -172,7 +174,7 @@ The buffer into which to copy the data. The index with the buffer to which the data will be copied. The maximum number of characters to read. - Reads a stream of characters from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . + Reads a specified number of characters from a specified column starting at a specified index, and writes them to a buffer starting at a specified position. The actual number of characters read. To be added. ADO.NET Overview @@ -205,8 +207,8 @@ The to get the column value from. The name of the column. - Returns a object for the requested column. - A object. + Returns a data reader for the requested column. + A data reader. To be added. ADO.NET Overview @@ -234,7 +236,7 @@ The to get the column value from. The name of the column. Gets name of the data type of the specified column. - A string representing the name of the data type. + The name of the data type. To be added. ADO.NET Overview @@ -290,7 +292,7 @@ The to get the column value from. The name of the column. - Gets the value of the specified column as a object. + Gets the value of the specified column as a . The value of the specified column. To be added. The specified cast is not valid. @@ -383,26 +385,26 @@ The name of the column. Synchronously gets the value of the specified column as the requested type. The value of the specified column. - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during data retrieval. -or- - The is closed during the data retrieval. + The was closed during data retrieval. -or- - There is no data ready to be read (for example, the first hasn't been called, or returned false). + There is no data ready to be read (for example, the first hasn't been called, or it returned ). -or- - Tried to read a previously-read column in sequential mode. + The reader tried to read a previously-read column in sequential mode. -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The column index is out of range. - doesn't match the type returned by the database or cannot be cast. + The type returned by the database doesn't match or cannot be cast to . @@ -432,7 +434,7 @@ The name of the column. An optional to cancel the asynchronous operation. Asynchronously gets the value of the specified column as the requestsed type. - The value of the specified column. + A task whose contains the value of the specified column. The connection drops or is closed during the data retrieval. -or- @@ -504,7 +506,7 @@ The to get the column value from. The name of the column. - Gets the value of the specified column as a globally-unique identifier (GUID). + Gets the value of the specified column as a globally unique identifier (GUID). The value of the specified column. To be added. The specified cast is not valid. @@ -688,7 +690,7 @@ The to get the column value from. The name of the column. Gets a to retrieve data from the specified column. - A object. + A stream. The to get the column value from. The name of the column. Gets a to retrieve data from the column. - A object. + A text reader. The name of the column. Gets a value that indicates whether the column contains nonexistent or missing values. - if the specified column is equivalent to ; otherwise . + if the specified column is equivalent to ; otherwise, . , , and so on) to avoid raising an error. + Call this method to check for null column values before calling the typed Get_*_ methods (for example, , , and so on) to avoid throwing an exception. ]]> @@ -884,10 +886,10 @@ The to get the column value from. The name of the column. - A System.Threading.CancellationToken to cancel the asynchronous operation. + A token to cancel the asynchronous operation. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - if the specified column value is equivalent to otherwise . + A whose property is if the specified column value is equivalent to or if it is not. The connection drops or is closed during the data retrieval. @@ -910,4 +912,4 @@ - \ No newline at end of file + From d16ab7774066794575a297ae79aedde5d93a9867 Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Fri, 19 Jul 2019 17:23:09 -0700 Subject: [PATCH 05/14] Addressing some of the feedback --- xml/System.Data.Common/DbDataReader.xml | 100 +++++++++++------------ xml/System.Data/DataReaderExtensions.xml | 100 +++++++++++------------ 2 files changed, 100 insertions(+), 100 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 348433f2e4a..6db3e328211 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -200,7 +200,7 @@ 4.2.0.0 - Releases the resources used by the and calls . + Releases the resources used by the and calls . ADO.NET Overview @@ -300,7 +300,7 @@ . + This method calls . ]]> @@ -515,7 +515,7 @@ The buffer into which to copy the data. The index with the buffer to which the data will be copied. The maximum number of characters to read. - Reads a stream of bytes from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . + Reads a specified number of bytes from the specified column starting at a specified index and writes them to a buffer starting at a specified position in the buffer. The actual number of bytes read. To be added. The specified cast is not valid. @@ -611,7 +611,7 @@ The buffer into which to copy the data. The index with the buffer to which the data will be copied. The maximum number of characters to read. - Reads a stream of characters from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . + Reads a specified number of characters from a specified column starting at a specified index, and writes them to a buffer starting at a specified position. The actual number of characters read. To be added. ADO.NET Overview @@ -656,8 +656,8 @@ The zero-based column ordinal. - Returns a object for the requested column. - A object. + Returns a nested data reader for the requested column. + A data reader. To be added. ADO.NET Overview @@ -700,7 +700,7 @@ The zero-based column ordinal. Gets name of the data type of the specified column. - A string representing the name of the data type. + The name of the data type. The zero-based column ordinal. - Gets the value of the specified column as a object. + Gets the value of the specified column as a . The value of the specified column. To be added. The specified cast is not valid. @@ -1034,13 +1034,13 @@ private static void GetDataTypes(String connectionString) { The type of the value to be returned. The zero-based column ordinal. - Synchronously gets the value of the specified column as the requested type. + Gets the value of the specified column as the requested type. The value of the specified column. - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during data retrieval. -or- - The is closed during the data retrieval. + The data reader was closed during data retrieval. -or- @@ -1048,14 +1048,14 @@ private static void GetDataTypes(String connectionString) { -or- - Tried to read a previously-read column in sequential mode. + The reader tried to read a previously-read column in sequential mode. -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The column index is out of range. - doesn't match the type returned by the database or cannot be cast. + The value returned by the database doesn't match or cannot be cast to . @@ -1105,16 +1105,16 @@ private static void GetDataTypes(String connectionString) { The type of the value to be returned. The zero-based column ordinal. Asynchronously gets the value of the specified column as the requested type. - The value of the specified column. + A task whose contains the value of the specified column. The connection was dropped or closed during data retrieval. -or- - The is closed during the data retrieval. + The data reader was closed during the data retrieval. -or- - There is no data ready to be read (for example, the first hasn't been called, or returned false). + There is no data ready to be read (for example, the first hasn't been called, or it returned ). -or- @@ -1122,10 +1122,10 @@ private static void GetDataTypes(String connectionString) { -or- - There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. + There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream. Trying to read a column that does not exist. - doesn't match the type returned by the data source or cannot be cast. + The value returned by the database doesn't match or cannot be cast to . @@ -1165,18 +1165,18 @@ private static void GetDataTypes(String connectionString) { The type of the value to be returned. The zero-based column ordinal. - An optional token to cancel the asynchronous operation. + A token to cancel the asynchronous operation. Asynchronously gets the value of the specified column as the requested type. - The value of the specified column. - The connection drops or is closed during the data retrieval. + A task whose contains the value of the specified column. + The connection was dropped or closed during data retrieval. -or- - The is closed during the data retrieval. + The data reader was closed during the data retrieval. -or- - There is no data ready to be read (for example, the first hasn't been called, or returned false). + There is no data ready to be read (for example, the first hasn't been called, or it returned ). -or- @@ -1184,10 +1184,10 @@ private static void GetDataTypes(String connectionString) { -or- - There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. + There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream. Trying to read a column that does not exist. - doesn't match the type returned by the data source or cannot be cast. + The value returned by the database doesn't match or cannot be cast to . @@ -1271,7 +1271,7 @@ private static void GetDataTypes(String connectionString) { The zero-based column ordinal. - Gets the value of the specified column as a globally-unique identifier (GUID). + Gets the value of the specified column as a globally unique identifier (GUID). The value of the specified column. To be added. The specified cast is not valid. @@ -1698,7 +1698,7 @@ private static void GetCredits(String connectionString) { Returns a that describes the column metadata of the . A that describes the column metadata. To be added. - The is closed. + The is closed. ADO.NET Overview @@ -1735,7 +1735,7 @@ private static void GetCredits(String connectionString) { The zero-based column ordinal. - Gets a to retrieve data from the specified column. + Gets a stream to retrieve data from the specified column. A stream. only supports the retrieval of values that can be converted to byte arrays. ]]> - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during the data retrieval. -or- - The is closed during the data retrieval. + The data reader is closed during the data retrieval. -or- @@ -1756,7 +1756,7 @@ private static void GetCredits(String connectionString) { -or- - Tried to read a previously-read column in sequential mode. + The data reader tried to read a previously-read column in sequential mode. -or- @@ -1842,7 +1842,7 @@ private static void GetCredits(String connectionString) { The zero-based column ordinal. - Gets a to retrieve data from the column. + Gets a text reader to retrieve data from the column. A text reader. only supports the retrieval of values that can be converted to character arrays (strings). ]]> - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during the data retrieval. -or- - The is closed during the data retrieval. + The data reader is closed during the data retrieval. -or- @@ -1863,7 +1863,7 @@ private static void GetCredits(String connectionString) { -or- - Tried to read a previously-read column in sequential mode. + The data reader tried to read a previously-read column in sequential mode. -or- @@ -1990,7 +1990,7 @@ private static void GetCredits(String connectionString) { Gets a value that indicates whether this contains one or more rows. - if the contains one or more rows; otherwise . + if the contains one or more rows; otherwise, . To be added. ADO.NET Overview @@ -2030,9 +2030,9 @@ private static void GetCredits(String connectionString) { Gets a value indicating whether the is closed. - if the is closed; otherwise . + if the is closed; otherwise, . To be added. - The is closed. + The is closed. This property and should be implemented to return a value when the reader is closed. @@ -2078,12 +2078,12 @@ private static void GetCredits(String connectionString) { The zero-based column ordinal. Gets a value that indicates whether the column contains nonexistent or missing values. - if the specified column is equivalent to ; otherwise . + if the specified column is equivalent to ; otherwise, . , , and so on) to avoid raising an error. + Call this method to check for null column values before calling the typed Get_*_ methods (for example, , , and so on) to avoid throwing an exception. ]]> @@ -2135,12 +2135,12 @@ private static void GetCredits(String connectionString) { The zero-based column to be retrieved. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - if the specified column value is equivalent to ; otherwise, . - The connection drops or is closed during the data retrieval. + A whose property is if the specified column value is equivalent to or if it is not. + The connection was dropped or closed during the data retrieval. -or- - The is closed during the data retrieval. + The data reader is closed during the data retrieval. -or- @@ -2189,15 +2189,15 @@ private static void GetCredits(String connectionString) { The zero-based column to be retrieved. - A cancellation token to cancel the asynchronous operation. The returned task must be marked as cancelled. + A token to cancel the asynchronous operation. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - if the specified column value is equivalent to otherwise . - The connection drops or is closed during the data retrieval. + A whose property is if the specified column value is equivalent to or if it is not. + The connection was dropped or closed during the data retrieval. -or- - The is closed during the data retrieval. + The data reader is closed during the data retrieval. -or- @@ -2348,7 +2348,7 @@ private static void GetCredits(String connectionString) { Advances the reader to the next result when reading the results of a batch of statements. - if there are more result sets; otherwise . + if there are more result sets; otherwise, . Advances the reader to the next record in a result set. - if there are more rows; otherwise . + if there are more rows; otherwise, . - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a byte. The value of the specified column. @@ -100,15 +100,13 @@ - The to get the column value from. + The data reader to get the column value from. The name of the column. The index within the row from which to begin the read operation. The buffer into which to copy the data. The index with the buffer to which the data will be copied. The maximum number of characters to read. Reads a specified number of bytes from the specified column starting at a specified index and writes them to a buffer starting at a specified position in the buffer. - -Using parameter names in summary descriptions is discouraged since it makes the summary unclear in the member list, where parameter names don't appear. The actual number of bytes read. To be added. The specified cast is not valid. @@ -135,7 +133,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a single character. The value of the specified column. @@ -168,7 +166,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. The index within the row from which to begin the read operation. The buffer into which to copy the data. @@ -205,9 +203,9 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. - Returns a data reader for the requested column. + Returns a nested data reader for the requested column. A data reader. To be added. ADO.NET Overview @@ -233,7 +231,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column type name from. The name of the column. Gets name of the data type of the specified column. The name of the data type. @@ -261,7 +259,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a object. The value of the specified column. @@ -290,7 +288,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a . The value of the specified column. @@ -319,7 +317,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a double-precision floating point number. The value of the specified column. @@ -348,7 +346,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the field type from. The name of the column. Gets the data type of the specified column. The data type of the specified column. @@ -381,15 +379,15 @@ Using parameter names in summary descriptions is discouraged since it makes the The type of the value to be returned. - The to get the column value from. + The data reader to get the column value from. The name of the column. - Synchronously gets the value of the specified column as the requested type. + Gets the value of the specified column as the requested type. The value of the specified column. The connection was dropped or closed during data retrieval. -or- - The was closed during data retrieval. + The data reader was closed during data retrieval. -or- @@ -402,9 +400,9 @@ Using parameter names in summary descriptions is discouraged since it makes the -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - The column index is out of range. + The name specified is not a valid column name. - The type returned by the database doesn't match or cannot be cast to . + The value returned by the database doesn't match or cannot be cast to . @@ -430,20 +428,20 @@ Using parameter names in summary descriptions is discouraged since it makes the The type of the value to be returned. - The to get the column value from. + The data reader to get the column value from. The name of the column. - An optional to cancel the asynchronous operation. - Asynchronously gets the value of the specified column as the requestsed type. + An optional token to cancel the asynchronous operation. + Asynchronously gets the value of the specified column as the requested type. A task whose contains the value of the specified column. - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during data retrieval. -or- - The is closed during the data retrieval. + The data reader was closed during the data retrieval. -or- - There is no data ready to be read (for example, the first hasn't been called, or returned false). + There is no data ready to be read (for example, the first hasn't been called, or it returned ). -or- @@ -451,8 +449,10 @@ Using parameter names in summary descriptions is discouraged since it makes the -or- - There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - + There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream. + Trying to read a column that does not exist. + + The value returned by the database doesn't match or cannot be cast to . @@ -475,7 +475,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a single-precision floating point number. The value of the specified column. @@ -504,7 +504,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a globally unique identifier (GUID). The value of the specified column. @@ -533,7 +533,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a 16-bit signed integer. The value of the specified column. @@ -562,7 +562,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a 32-bit signed integer. The value of the specified column. @@ -591,7 +591,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as a 64-bit signed integer. The value of the specified column. @@ -625,7 +625,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the provider-specific type of the specified column. The object that describes the data type of the specified column. @@ -658,7 +658,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as an instance of . The value of the specified column. @@ -687,9 +687,9 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. - Gets a to retrieve data from the specified column. + Gets a stream to retrieve data from the specified column. A stream. only supports the retrieval of values that can be converted to byte arrays. ]]> - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during the data retrieval. -or- - The is closed during the data retrieval. + The data reader is closed during the data retrieval. -or- @@ -710,7 +710,7 @@ Using parameter names in summary descriptions is discouraged since it makes the -or- - Tried to read a previously-read column in sequential mode. + The data reader tried to read a previously-read column in sequential mode. -or- @@ -739,7 +739,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as an instance of . The value of the specified column. @@ -768,9 +768,9 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. - Gets a to retrieve data from the column. + Gets a text reader to retrieve data from the column. A text reader. only supports the retrieval of values that can be converted to character arrays (strings). ]]> - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during the data retrieval. -or- - The is closed during the data retrieval. + The data reader is closed during the data retrieval. -or- @@ -791,7 +791,7 @@ Using parameter names in summary descriptions is discouraged since it makes the -or- - Tried to read a previously-read column in sequential mode. + The data reader tried to read a previously-read column in sequential mode. -or- @@ -821,7 +821,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets the value of the specified column as an instance of . The value of the specified column. @@ -849,7 +849,7 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. Gets a value that indicates whether the column contains nonexistent or missing values. @@ -884,18 +884,18 @@ Using parameter names in summary descriptions is discouraged since it makes the - The to get the column value from. + The data reader to get the column value from. The name of the column. - A token to cancel the asynchronous operation. + An optional token to cancel the asynchronous operation. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. A whose property is if the specified column value is equivalent to or if it is not. - The connection drops or is closed during the data retrieval. + The connection was dropped or closed during the data retrieval. -or- - The is closed during the data retrieval. + The data reader is closed during the data retrieval. -or- From 19b2863f4aac8d8c4f5f7fc7c76645cb7d0f8751 Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Fri, 19 Jul 2019 17:28:52 -0700 Subject: [PATCH 06/14] Minor tweak --- xml/System.Data.Common/DbDataReader.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 6db3e328211..c189dabb351 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -1064,7 +1064,7 @@ private static void GetDataTypes(String connectionString) { 4.1.0.0 - Asynchronously gets the value of the specified column as the specified type. + Asynchronously gets the value of the specified column as the requested type. From 77d4c34ba11bf454252a03167420cc41e74fac32 Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Fri, 19 Jul 2019 17:38:13 -0700 Subject: [PATCH 07/14] Fixed Task.Task.Result --- xml/System.Data.Common/DbDataReader.xml | 4 ++-- xml/System.Data/DataReaderExtensions.xml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index c189dabb351..1cba11373f3 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -2135,7 +2135,7 @@ private static void GetCredits(String connectionString) { The zero-based column to be retrieved. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - A whose property is if the specified column value is equivalent to or if it is not. + A whose property is if the specified column value is equivalent to or if it is not. The connection was dropped or closed during the data retrieval. -or- @@ -2192,7 +2192,7 @@ private static void GetCredits(String connectionString) { A token to cancel the asynchronous operation. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - A whose property is if the specified column value is equivalent to or if it is not. + A whose property is if the specified column value is equivalent to or if it is not. The connection was dropped or closed during the data retrieval. -or- diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index 75f587bc35e..08f4f4e65c7 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -889,7 +889,7 @@ An optional token to cancel the asynchronous operation. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - A whose property is if the specified column value is equivalent to or if it is not. + A whose property is if the specified column value is equivalent to or if it is not. The connection was dropped or closed during the data retrieval. From d01519a071cc68b05aa0c8f703d01c0d1eb03aa4 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Mon, 22 Jul 2019 12:13:55 -0700 Subject: [PATCH 08/14] Fixed broken cref and xref --- xml/System.Data.Common/DbDataReader.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 1cba11373f3..ff8a959ea39 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -300,7 +300,7 @@ . + This method calls . ]]> @@ -2135,7 +2135,7 @@ private static void GetCredits(String connectionString) { The zero-based column to be retrieved. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - A whose property is if the specified column value is equivalent to or if it is not. + A whose property is if the specified column value is equivalent to or if it is not. The connection was dropped or closed during the data retrieval. -or- From bce82dee6c70c842cd0bd1b7a0e5223c3b1957b1 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Mon, 22 Jul 2019 12:15:52 -0700 Subject: [PATCH 09/14] fixred broken cref --- xml/System.Data/DataReaderExtensions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index 08f4f4e65c7..a123b47641b 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -889,7 +889,7 @@ An optional token to cancel the asynchronous operation. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - A whose property is if the specified column value is equivalent to or if it is not. + A whose property is if the specified column value is equivalent to or if it is not. The connection was dropped or closed during the data retrieval. From 5b1d2b8ae401365ddc44e16d14acbda7c9f78b29 Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Mon, 22 Jul 2019 16:39:47 -0700 Subject: [PATCH 10/14] Adding SequentialAccess remark --- xml/System.Data.Common/DbDataReader.xml | 44 ++++++++++++++++++++++-- xml/System.Data/DataReaderExtensions.xml | 21 +++++++++-- 2 files changed, 60 insertions(+), 5 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index ff8a959ea39..8f62e6f1d5b 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -1106,6 +1106,16 @@ private static void GetDataTypes(String connectionString) { The zero-based column ordinal. Asynchronously gets the value of the specified column as the requested type. A task whose contains the value of the specified column. + + is called with . + + If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + ]]> + + The connection was dropped or closed during data retrieval. -or- @@ -1168,6 +1178,15 @@ private static void GetDataTypes(String connectionString) { A token to cancel the asynchronous operation. Asynchronously gets the value of the specified column as the requested type. A task whose contains the value of the specified column. + + is called with . + + If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + ]]> + The connection was dropped or closed during data retrieval. -or- @@ -1561,7 +1580,7 @@ private static void GetCredits(String connectionString) { The zero-based column ordinal. Gets the provider-specific type of the specified column. - The object that describes the data type of the specified column. + A provider-specific .NET type. To be added. ADO.NET Overview @@ -2136,7 +2155,16 @@ private static void GetCredits(String connectionString) { Asynchronously gets a value that indicates whether the column contains non-existent or missing values. A whose property is if the specified column value is equivalent to or if it is not. - The connection was dropped or closed during the data retrieval. + + is called with . + + If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + ]]> + +The connection was dropped or closed during the data retrieval. -or- @@ -2193,7 +2221,17 @@ private static void GetCredits(String connectionString) { Asynchronously gets a value that indicates whether the column contains non-existent or missing values. A whose property is if the specified column value is equivalent to or if it is not. - The connection was dropped or closed during the data retrieval. + + is called with . + + If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + ]]> + + + The connection was dropped or closed during the data retrieval. -or- diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index a123b47641b..42b8004036c 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -433,6 +433,15 @@ An optional token to cancel the asynchronous operation. Asynchronously gets the value of the specified column as the requested type. A task whose contains the value of the specified column. + + is called with . + + If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + ]]> + The connection was dropped or closed during data retrieval. -or- @@ -628,7 +637,7 @@ The data reader to get the column value from. The name of the column. Gets the provider-specific type of the specified column. - The object that describes the data type of the specified column. + A provider-specific .NET type. To be added. ADO.NET Overview @@ -890,7 +899,15 @@ Asynchronously gets a value that indicates whether the column contains non-existent or missing values. A whose property is if the specified column value is equivalent to or if it is not. - + + is called with . + + If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + ]]> + The connection was dropped or closed during the data retrieval. -or- From 5b04bb411b2f3ad9de54dc486806277da75b81fa Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Mon, 22 Jul 2019 17:46:21 -0700 Subject: [PATCH 11/14] Fix another instance of Task.Result --- xml/System.Data.Common/DbDataReader.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 8f62e6f1d5b..71ed8c49f86 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -2220,7 +2220,7 @@ private static void GetCredits(String connectionString) { A token to cancel the asynchronous operation. Asynchronously gets a value that indicates whether the column contains non-existent or missing values. - A whose property is if the specified column value is equivalent to or if it is not. + A whose property is if the specified column value is equivalent to or if it is not. Date: Mon, 22 Jul 2019 17:56:56 -0700 Subject: [PATCH 12/14] Tweak remarks --- xml/System.Data.Common/DbDataReader.xml | 16 ++++++++-------- xml/System.Data/DataReaderExtensions.xml | 8 ++++---- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 71ed8c49f86..67cc25f7750 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -1110,9 +1110,9 @@ private static void GetDataTypes(String connectionString) { is called with . + This asynchronous method should only be used to avoid using blocking I/O when the reader is created in sequential mode. - If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + If sequential mode isn't specificied, the data for all column values is readily available in memory immediately after ReadAsync completes. ]]> @@ -1182,9 +1182,9 @@ private static void GetDataTypes(String connectionString) { is called with . + This asynchronous method should only be used to avoid using blocking I/O when the reader is created in sequential mode. - If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + If sequential mode isn't specificied, the data for all column values is readily available in memory immediately after ReadAsync completes. ]]> The connection was dropped or closed during data retrieval. @@ -2159,9 +2159,9 @@ private static void GetCredits(String connectionString) { is called with . + This asynchronous method should only be used to avoid using blocking I/O when the reader is created in sequential mode. - If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + If sequential mode isn't specificied, the data for all column values is readily available in memory immediately after ReadAsync completes. ]]> The connection was dropped or closed during the data retrieval. @@ -2225,9 +2225,9 @@ private static void GetCredits(String connectionString) { is called with . + This asynchronous method should only be used to avoid using blocking I/O when the reader is created in sequential mode. - If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + If sequential mode isn't specificied, the data for all column values is readily available in memory immediately after ReadAsync completes. ]]> diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index 42b8004036c..c7d2b0d2675 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -437,9 +437,9 @@ is called with . + This asynchronous method should only be used to avoid using blocking I/O when the reader is created in sequential mode. - If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + If sequential mode isn't specificied, the data for all column values is readily available in memory immediately after ReadAsync completes. ]]> The connection was dropped or closed during data retrieval. @@ -903,9 +903,9 @@ is called with . + This asynchronous method should only be used to avoid using blocking I/O when the reader is created in sequential mode. - If sequential access isn't specificied, the data for all values is available in memory immediately after completes. + If sequential mode isn't specificied, the data for all column values is readily available in memory immediately after ReadAsync completes. ]]> The connection was dropped or closed during the data retrieval. From bf0411d2b69a2921849642c70b5b37472d264d33 Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Thu, 25 Jul 2019 17:42:56 -0700 Subject: [PATCH 13/14] More async and consistency goodness --- xml/System.Data.Common/DbDataReader.xml | 156 +++++++++++++++-------- xml/System.Data/DataReaderExtensions.xml | 66 +++++++--- 2 files changed, 154 insertions(+), 68 deletions(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 67cc25f7750..0eaa74305f5 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -422,6 +422,7 @@ Gets the value of the specified column as a Boolean. The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -466,6 +467,7 @@ Gets the value of the specified column as a byte. The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -518,6 +520,8 @@ Reads a specified number of bytes from the specified column starting at a specified index and writes them to a buffer starting at a specified position in the buffer. The actual number of bytes read. To be added. + + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -562,6 +566,7 @@ Gets the value of the specified column as a single character. The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -659,6 +664,7 @@ Returns a nested data reader for the requested column. A data reader. To be added. + The column index is out of range. ADO.NET Overview @@ -724,6 +730,7 @@ private static void GetDataTypes(String connectionString) { ]]> + The column index is out of range. ADO.NET Overview @@ -767,6 +774,7 @@ private static void GetDataTypes(String connectionString) { Gets the value of the specified column as a object. The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -851,6 +859,7 @@ private static void GetDataTypes(String connectionString) { Gets the value of the specified column as a . The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -993,6 +1002,7 @@ private static void GetDataTypes(String connectionString) { Gets the data type of the specified column. The data type of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -1108,11 +1118,17 @@ private static void GetDataTypes(String connectionString) { A task whose contains the value of the specified column. @@ -1133,7 +1149,7 @@ private static void GetDataTypes(String connectionString) { -or- There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The column index is out of range. The value returned by the database doesn't match or cannot be cast to . @@ -1180,11 +1196,18 @@ private static void GetDataTypes(String connectionString) { A task whose contains the value of the specified column. The connection was dropped or closed during data retrieval. @@ -1204,7 +1227,7 @@ private static void GetDataTypes(String connectionString) { -or- There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The column index is out of range. The value returned by the database doesn't match or cannot be cast to . @@ -1249,6 +1272,7 @@ private static void GetDataTypes(String connectionString) { Gets the value of the specified column as a single-precision floating point number. The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -1293,6 +1317,7 @@ private static void GetDataTypes(String connectionString) { Gets the value of the specified column as a globally unique identifier (GUID). The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -1337,6 +1362,7 @@ private static void GetDataTypes(String connectionString) { Gets the value of the specified column as a 16-bit signed integer. The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -1405,6 +1431,7 @@ private static void GetCredits(String connectionString) { ]]> + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -1449,6 +1476,7 @@ private static void GetCredits(String connectionString) { Gets the value of the specified column as a 64-bit signed integer. The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -1582,6 +1610,7 @@ private static void GetCredits(String connectionString) { Gets the provider-specific type of the specified column. A provider-specific .NET type. To be added. + The column index is out of range. ADO.NET Overview @@ -1624,7 +1653,7 @@ private static void GetCredits(String connectionString) { The zero-based column ordinal. - Gets the value of the specified column as an instance of . + Gets the value of the specified column as an instance of a provider-specific type. The value of the specified column. An array of into which to copy the attribute columns. Gets all provider-specific attribute columns in the collection for the current row. - The number of instances of in the array. + The number of instances of elements in the array. To be added. ADO.NET Overview @@ -1718,6 +1747,7 @@ private static void GetCredits(String connectionString) { A that describes the column metadata. To be added. The is closed. + The column index is out of range. ADO.NET Overview @@ -1780,7 +1810,7 @@ private static void GetCredits(String connectionString) { -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The column index is out of range. The specified column isn't a binary type that supports reading with a . @@ -1824,6 +1854,7 @@ private static void GetCredits(String connectionString) { Gets the value of the specified column as an instance of . The value of the specified column. To be added. + The column index is out of range. The specified cast is not valid. ADO.NET Overview @@ -1887,7 +1918,7 @@ private static void GetCredits(String connectionString) { -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The column index is out of range. The specified column isn't a text type that supports reading with a . @@ -1931,6 +1962,7 @@ private static void GetCredits(String connectionString) { Gets the value of the specified column as an instance of . The value of the specified column. To be added. + The column index is out of range. ADO.NET Overview @@ -2106,6 +2138,7 @@ private static void GetCredits(String connectionString) { ]]> + The column index is out of range. ADO.NET Overview @@ -2158,10 +2191,16 @@ private static void GetCredits(String connectionString) { The connection was dropped or closed during the data retrieval. @@ -2181,7 +2220,7 @@ private static void GetCredits(String connectionString) { -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The column index is out of range. @@ -2224,10 +2263,17 @@ private static void GetCredits(String connectionString) { @@ -2248,7 +2294,7 @@ private static void GetCredits(String connectionString) { -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The column index is out of range. @@ -2302,7 +2348,7 @@ private static void GetCredits(String connectionString) { Gets the value of the specified column as an instance of . The value of the specified column. To be added. - The index passed was outside the range of 0 through . + The column index is out of range. ADO.NET Overview @@ -2404,7 +2450,7 @@ private static void GetCredits(String connectionString) { 4.1.0.0 - Implements the asynchronous version of , but returns a Task synchronously, blocking the calling thread. + Asynchronously advances the reader to the next result when reading the results of a batch of statements. - An asynchronous version of , which advances the reader to the next result when reading the results of a batch of statements. - - Invokes with CancellationToken.None. - A task representing the asynchronous operation. + Asynchronously advances the reader to the next result when reading the results of a batch of statements. + A whose property is if there are more result sets or if there aren't. An error occurred while executing the command text. @@ -2494,18 +2540,18 @@ private static void GetCredits(String connectionString) { The cancellation instruction. - This is the asynchronous version of . Providers should override with an appropriate implementation. The may optionally be ignored. - - The default implementation invokes the synchronous method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled . Exceptions thrown by will be communicated via the returned Task Exception property. - - Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed. - A task representing the asynchronous operation. + Asynchronously advances the reader to the next result when reading the results of a batch of statements. + A whose property is if there are more result sets or if there aren't. An error occurred while executing the command text. @@ -2566,7 +2612,7 @@ private static void GetCredits(String connectionString) { 4.1.0.0 - Implements the asynchronous version of , but returns a Task synchronously, blocking the calling thread. + Asynchronously advances the reader to the next record in a result set. - An asynchronous version of , which advances the reader to the next record in a result set. This method invokes with CancellationToken.None. - A task representing the asynchronous operation. + Asynchronously advances the reader to the next record in a result set. + A whose property is if there are more rows or if there aren't. An error occurred while executing the command text. @@ -2654,18 +2703,19 @@ private static void GetCredits(String connectionString) { The cancellation instruction. - This is the asynchronous version of . Providers should override with an appropriate implementation. The cancellationToken may optionally be ignored. - - The default implementation invokes the synchronous method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by Read will be communicated via the returned Task Exception property. - - Do not invoke other methods and properties of the object until the returned Task is complete. - A task representing the asynchronous operation. + Asynchronously advances the reader to the next record in a result set. + A whose property is if there are more rows or if there aren't. An error occurred while executing the command text. diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index c7d2b0d2675..21c6b2c9350 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -43,6 +43,7 @@ Gets the value of the specified column as a Boolean. The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -72,6 +73,7 @@ Gets the value of the specified column as a byte. The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -109,6 +111,7 @@ Reads a specified number of bytes from the specified column starting at a specified index and writes them to a buffer starting at a specified position in the buffer. The actual number of bytes read. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -138,7 +141,8 @@ Gets the value of the specified column as a single character. The value of the specified column. To be added. - The specified cast is not valid. + The name specified is not a valid column name. + The specified cast is not valid. ADO.NET Overview @@ -175,6 +179,7 @@ Reads a specified number of characters from a specified column starting at a specified index, and writes them to a buffer starting at a specified position. The actual number of characters read. To be added. + The name specified is not a valid column name. ADO.NET Overview @@ -208,6 +213,7 @@ Returns a nested data reader for the requested column. A data reader. To be added. + The name specified is not a valid column name. ADO.NET Overview @@ -236,6 +242,7 @@ Gets name of the data type of the specified column. The name of the data type. To be added. + The name specified is not a valid column name. ADO.NET Overview @@ -264,7 +271,8 @@ Gets the value of the specified column as a object. The value of the specified column. To be added. - The specified cast is not valid. + The name specified is not a valid column name. + The specified cast is not valid. ADO.NET Overview @@ -293,6 +301,7 @@ Gets the value of the specified column as a . The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -323,6 +332,7 @@ The value of the specified column. To be added. The specified cast is not valid. + The name specified is not a valid column name. ADO.NET Overview @@ -351,6 +361,7 @@ Gets the data type of the specified column. The data type of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -435,11 +446,18 @@ A task whose contains the value of the specified column. The connection was dropped or closed during data retrieval. @@ -459,9 +477,8 @@ -or- There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. - - The value returned by the database doesn't match or cannot be cast to . + The name specified is not a valid column name. + The value returned by the database doesn't match or cannot be cast to . @@ -489,6 +506,7 @@ Gets the value of the specified column as a single-precision floating point number. The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -518,6 +536,7 @@ Gets the value of the specified column as a globally unique identifier (GUID). The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -547,6 +566,7 @@ Gets the value of the specified column as a 16-bit signed integer. The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -576,6 +596,7 @@ Gets the value of the specified column as a 32-bit signed integer. The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -605,6 +626,7 @@ Gets the value of the specified column as a 64-bit signed integer. The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -639,6 +661,7 @@ Gets the provider-specific type of the specified column. A provider-specific .NET type. To be added. + The name specified is not a valid column name. ADO.NET Overview @@ -669,10 +692,11 @@ The data reader to get the column value from. The name of the column. - Gets the value of the specified column as an instance of . + Gets the value of the specified column as an instance of a provider-specific type. The value of the specified column. To be added. - The specified cast is not valid. + The name specified is not a valid column name. + The specified cast is not valid. ADO.NET Overview @@ -724,7 +748,7 @@ -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The name specified is not a valid column name. The specified column isn't a binary type that supports reading with a . @@ -753,6 +777,7 @@ Gets the value of the specified column as an instance of . The value of the specified column. To be added. + The name specified is not a valid column name. The specified cast is not valid. ADO.NET Overview @@ -805,7 +830,7 @@ -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The name specified is not a valid column name. The specified column isn't a text type that supports reading with a . @@ -835,6 +860,7 @@ Gets the value of the specified column as an instance of . The value of the specified column. To be added. + The name specified is not a valid column name. ADO.NET Overview @@ -871,6 +897,7 @@ ]]> + The name specified is not a valid column name. ADO.NET Overview @@ -902,10 +929,19 @@ The connection was dropped or closed during the data retrieval. @@ -925,7 +961,7 @@ -or- There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. - Trying to read a column that does not exist. + The name specified is not a valid column name. From f11dec5b877ab3f4623bc285968755db565e64ce Mon Sep 17 00:00:00 2001 From: Diego Vega Date: Thu, 25 Jul 2019 17:56:12 -0700 Subject: [PATCH 14/14] Removed empty line --- xml/System.Data.Common/DbDataReader.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 0eaa74305f5..7774967e5d4 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -520,7 +520,6 @@ Reads a specified number of bytes from the specified column starting at a specified index and writes them to a buffer starting at a specified position in the buffer. The actual number of bytes read. To be added. - The column index is out of range. The specified cast is not valid. ADO.NET Overview