Fix | ExecuteReaderAsync API xml and ref files (#2373)

dotnet · Feb 28, 2024 · faf9b95 · faf9b95
1 parent 51ef22c
commit faf9b95
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml
@@ -111,6 +111,7 @@ The following example creates a <xref:Microsoft.Data.SqlClient.SqlConnection> an
       </remarks>
     </ExecuteReader>
     <ExecuteReaderAsync>
+      <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
       <summary>
         An asynchronous version of
         <see cref="M:Microsoft.Data.SqlClient.SqlBatch.ExecuteReader"/>
@@ -122,6 +123,10 @@ The following example creates a <xref:Microsoft.Data.SqlClient.SqlConnection> an
         <see cref="T:Microsoft.Data.SqlClient.SqlDataReader"/>.
         Exceptions will be reported via the returned Task object.
       </summary>
+      <returns>A task representing the asynchronous operation.</returns>
+      <exception cref="T:Microsoft.Data.SqlClient.SqlException">An error occurred while executing the batch.</exception>
+      <exception cref="T:System.ArgumentException">The <see cref="T:System.Data.CommandBehavior" /> value is invalid.</exception>
+      <exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
     </ExecuteReaderAsync>
     <DbBatchCommands>
       <summary>Gets the collection of <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> objects.</summary>

diff --git a/src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.Batch.cs b/src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.Batch.cs
@@ -44,7 +44,7 @@ public class SqlBatch : System.Data.Common.DbBatch
         /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml' path='docs/members[@name="SqlBatch"]/ExecuteReader/*'/>
         public Microsoft.Data.SqlClient.SqlDataReader ExecuteReader() => throw null;       
         /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml' path='docs/members[@name="SqlBatch"]/ExecuteReaderAsync/*'/>
-        public System.Threading.Tasks.Task<Microsoft.Data.SqlClient.SqlDataReader> ExecuteReaderAsync() => throw null;
+        public new System.Threading.Tasks.Task<Microsoft.Data.SqlClient.SqlDataReader> ExecuteReaderAsync(System.Threading.CancellationToken cancellationToken = default) => throw null;
         /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml' path='docs/members[@name="SqlBatch"]/ExecuteScalar/*'/>
         public override object ExecuteScalar() => throw null;
         /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml' path='docs/members[@name="SqlBatch"]/ExecuteScalarAsync/*'/>