Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix | ExecuteReaderAsync API xml and ref files #2373

Merged
merged 3 commits into from Feb 28, 2024
Merged

Fix | ExecuteReaderAsync API xml and ref files #2373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d266e0a
Fix | ExecuteReaderAsync API return type in ref file
DavoudEshtehari Feb 27, 2024
7bd15d3
Merge remote-tracking branch 'Upstream/main' into Adhoc/fix-api-batch
DavoudEshtehari Feb 28, 2024
25dec6e
Fix | ExecuteReaderAsync API xml and ref files
DavoudEshtehari Feb 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml
View file
Open in desktop
Expand Up @@ -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"/>
Expand All @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.Batch.cs
View file
Open in desktop
Expand Up @@ -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/*'/>
Expand Down