|
732 | 732 | </Parameters>
|
733 | 733 | <Docs>
|
734 | 734 | <param name="behavior">Options for statement execution and data retrieval.</param>
|
735 |
| - <param name="cancellationToken">The token to monitor for cancellation requests.</param> |
| 735 | + <param name="cancellationToken">A token to cancel the asynchronous operation.</param> |
736 | 736 | <summary>Providers should implement this method to provide a non-default implementation for <see cref="Overload:System.Data.Common.DbCommand.ExecuteReader" /> overloads.
|
737 | 737 |
|
738 | 738 | The default implementation invokes the synchronous <see cref="M:System.Data.Common.DbCommand.ExecuteReader" /> method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteReader will be communicated via the returned Task Exception property.
|
|
898 | 898 | <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
|
899 | 899 | </Parameters>
|
900 | 900 | <Docs>
|
901 |
| - <param name="cancellationToken">The token to monitor for cancellation requests.</param> |
| 901 | + <param name="cancellationToken">A token to cancel the asynchronous operation.</param> |
902 | 902 | <summary>This is the asynchronous version of <see cref="M:System.Data.Common.DbCommand.ExecuteNonQuery" />. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.
|
903 | 903 |
|
904 | 904 | The default implementation invokes the synchronous <see cref="M:System.Data.Common.DbCommand.ExecuteNonQuery" /> method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by <see cref="M:System.Data.Common.DbCommand.ExecuteNonQuery" /> will be communicated via the returned Task Exception property.
|
|
1151 | 1151 | <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
|
1152 | 1152 | </Parameters>
|
1153 | 1153 | <Docs>
|
1154 |
| - <param name="cancellationToken">The token to monitor for cancellation requests.</param> |
| 1154 | + <param name="cancellationToken">A token to cancel the asynchronous operation.</param> |
1155 | 1155 | <summary>An asynchronous version of <see cref="Overload:System.Data.Common.DbCommand.ExecuteReader" />, which executes the <see cref="P:System.Data.Common.DbCommand.CommandText" /> against the <see cref="P:System.Data.Common.DbCommand.Connection" /> and returns a <see cref="T:System.Data.Common.DbDataReader" />. This method propagates a notification that operations should be canceled.
|
1156 | 1156 |
|
1157 | 1157 | Invokes <see cref="M:System.Data.Common.DbCommand.ExecuteDbDataReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)" />.</summary>
|
|
1202 | 1202 | </Parameters>
|
1203 | 1203 | <Docs>
|
1204 | 1204 | <param name="behavior">One of the enumeration values that specifies the command behavior.</param>
|
1205 |
| - <param name="cancellationToken">The token to monitor for cancellation requests.</param> |
| 1205 | + <param name="cancellationToken">A token to cancel the asynchronous operation.</param> |
1206 | 1206 | <summary>Invokes <see cref="M:System.Data.Common.DbCommand.ExecuteDbDataReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)" />.</summary>
|
1207 | 1207 | <returns>A task representing the asynchronous operation.</returns>
|
1208 | 1208 | <remarks>
|
|
1362 | 1362 | <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
|
1363 | 1363 | </Parameters>
|
1364 | 1364 | <Docs>
|
1365 |
| - <param name="cancellationToken">The token to monitor for cancellation requests.</param> |
| 1365 | + <param name="cancellationToken">A token to cancel the asynchronous operation.</param> |
1366 | 1366 | <summary>This is the asynchronous version of <see cref="M:System.Data.Common.DbCommand.ExecuteScalar" />. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.
|
1367 | 1367 |
|
1368 | 1368 | The default implementation invokes the synchronous <see cref="M:System.Data.Common.DbCommand.ExecuteScalar" /> method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteScalar will be communicated via the returned Task Exception property.
|
|
1495 | 1495 | <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="netcore-3.0;netstandard-2.1" />
|
1496 | 1496 | </Parameters>
|
1497 | 1497 | <Docs>
|
1498 |
| - <param name="cancellationToken">To be added.</param> |
| 1498 | + <param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="CancellationToken.None"/>.</param> |
1499 | 1499 | <summary>Asynchronously creates a prepared (or compiled) version of the command on the data source.</summary>
|
1500 | 1500 | <returns>A <see cref="P:System.Threading.Tasks.Task" /> representing the asynchronous operation.</returns>
|
1501 | 1501 | <remarks>
|
|
1506 | 1506 |
|
1507 | 1507 | Data providers that support [asynchronous programming](~/docs/framework/data/adonet/asynchronous-programming.md) should override the default implementation using asynchronous I/O operations.
|
1508 | 1508 |
|
1509 |
| - If the <xref:System.Data.Common.DbCommand.CommandType%2A> property is set to `TableDirect`, `Prepare` does nothing. If <xref:System.Data.Common.DbCommand.CommandType%2A> is set to `StoredProcedure`, the call to `Prepare` should succeed, although it may result in a no-op. |
| 1509 | + If the <xref:System.Data.Common.DbCommand.CommandType%2A> property is set to `TableDirect`, `PrepareAsync` does nothing. If <xref:System.Data.Common.DbCommand.CommandType%2A> is set to `StoredProcedure`, the call to `PrepareAsync` should succeed, although it may result in a no-op. |
1510 | 1510 |
|
1511 | 1511 | ]]></format>
|
1512 | 1512 | </remarks>
|
|
0 commit comments