Skip to content

Commit 5053515

Browse files
johnnyphamjohnnypham
authored
Fixes for issues from API docs build (#622)
1 parent 5e22e5f commit 5053515

File tree

3 files changed

+76
-66
lines changed

3 files changed

+76
-66
lines changed

‎doc/snippets/Microsoft.Data.SqlClient/SqlBulkCopy.xml‎

Lines changed: 64 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ If the data is sorted in an order that differs from the order of a clustered ind
391391
<format type="text/markdown"><![CDATA[
392392
## Remarks
393393
If <xref:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName> has not been set when <xref:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer%2A> is called, an <xref:System.ArgumentNullException>
394-
is thrown. If <xref:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName> is modified while a <xref:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer%2A> operation is running,
394+
is thrown. If <xref:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName> is modified while a <xref:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer%2A> operation is running,
395395
the change does not affect the current operation. The new <xref:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName> value is used the next time a <xref:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer%2A> method is called.
396396
397397
<xref:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName> is a three-part name (`<database>.<owningschema>.<name>`). You can qualify the table name with its database and owning schema if you choose.
@@ -632,7 +632,7 @@ The following Console application demonstrates how to bulk load data from a <xre
632632
In this example, a <xref:System.Data.DataTable> is created at run time and is the source of the `SqlBulkCopy` operation.
633633
634634
> [!IMPORTANT]
635-
> This sample will not run unless you have created the work tables as described in [Bulk Copy Example Setup](/dotnet/framework/data/adonet/sql/bulk-copy-example-setup).
635+
> This sample will not run unless you have created the work tables as described in [Bulk Copy Example Setup](/dotnet/framework/data/adonet/sql/bulk-copy-example-setup).
636636
This code is provided to demonstrate the syntax for using **SqlBulkCopy** only. If the source and destination tables are in the same SQL Server instance, it is easier and faster to use a Transact-SQL `INSERT … SELECT` statement to copy the data.
637637
638638
[!code-csharp[SqlBulkCopy.DataTable#1](~/../sqlclient/doc/samples/SqlBulkCopy_DataTable.cs#1)]
@@ -720,7 +720,7 @@ The following console application demonstrates how to bulk load data from a <xre
720720
In this example, a <xref:System.Data.DataTable> is created at run time. A single row is selected from the <xref:System.Data.DataTable> to copy to the destination table.
721721
722722
> [!IMPORTANT]
723-
> This sample will not run unless you have created the work tables as described in [Bulk Copy Example Setup](/dotnet/framework/data/adonet/sql/bulk-copy-example-setup). This code is provided to demonstrate the syntax for using **SqlBulkCopy** only. If the source and destination tables are in the same SQL Server instance, it is easier and faster to use a Transact-SQL `INSERT … SELECT` statement to copy the data.
723+
> This sample will not run unless you have created the work tables as described in [Bulk Copy Example Setup](/dotnet/framework/data/adonet/sql/bulk-copy-example-setup). This code is provided to demonstrate the syntax for using **SqlBulkCopy** only. If the source and destination tables are in the same SQL Server instance, it is easier and faster to use a Transact-SQL `INSERT … SELECT` statement to copy the data.
724724
725725
[!code-csharp[SqlBulkCopy.RowArray#1](~/../sqlclient/doc/samples/SqlBulkCopy_RowArray.cs#1)]
726726
@@ -740,8 +740,7 @@ In this example, a <xref:System.Data.DataTable> is created at run time. A single
740740
</param>
741741
<summary>
742742
The asynchronous version of
743-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataRow[])" />
744-
,
743+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataRow[])" />,
745744
which copies all rows from the supplied
746745
<see cref="T:System.Data.DataRow" />
747746
array to a destination table specified by the
@@ -762,7 +761,7 @@ For more information about asynchronous programming in the .NET Framework Data P
762761
<exception cref="T:System.InvalidOperationException">
763762
Calling
764763
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataRow[])" />
765-
multiple times for the same instance before task completion. Calling
764+
multiple times for the same instance before task completion. Calling
766765
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataRow[])" />
767766
and
768767
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataRow[])" />
@@ -802,21 +801,20 @@ For more information about asynchronous programming in the .NET Framework Data P
802801
The cancellation instruction. A
803802
<see cref="P:System.Threading.CancellationToken.None" />
804803
value in this parameter makes this method equivalent to
805-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataTable)" />
806-
.
804+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataTable)" />.
807805
</param>
808806
<summary>
809807
The asynchronous version of
810-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataRow[])" />
811-
, which copies all rows from the supplied
808+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataRow[])" />,
809+
which copies all rows from the supplied
812810
<see cref="T:System.Data.DataRow" />
813811
array to a destination table specified by the
814812
<see cref="P:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName" />
815813
property of the
816814
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopy" />
817815
object.
818816

819-
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
817+
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
820818
</summary>
821819
<returns>
822820
A task representing the asynchronous operation.
@@ -830,20 +828,31 @@ For more information about asynchronous programming in the .NET Framework Data P
830828
<exception cref="T:System.InvalidOperationException">
831829
Calling
832830
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataRow[])" />
833-
multiple times for the same instance before
834-
task completion. Calling
831+
multiple times for the same instance before task completion.
832+
833+
Calling
835834
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataRow[])" />
836835
and
837836
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataRow[])" />
838-
for the same instance before task completion. The connection drops or is closed during
837+
for the same instance before task completion.
838+
839+
The connection drops or is closed during
839840
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataRow[])" />
840-
execution. Returned in the task object, the
841+
execution.
842+
843+
Returned in the task object, the
841844
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopy" />
842-
object was closed during the method execution. Returned in the task object, there was a connection pool timeout. Returned in the task object, the
845+
object was closed during the method execution.
846+
847+
Returned in the task object, there was a connection pool timeout.
848+
849+
Returned in the task object, the
843850
<see cref="T:Microsoft.Data.SqlClient.SqlConnection" />
844851
object is closed before method execution.
852+
845853
<see langword="Context Connection=true" />
846854
is specified in the connection string.
855+
847856
A
848857
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopyColumnOrderHint" />
849858
did not specify a valid destination column name.
@@ -860,8 +869,8 @@ For more information about asynchronous programming in the .NET Framework Data P
860869
</param>
861870
<summary>
862871
The asynchronous version of
863-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.IDataReader)" />
864-
, which copies all rows in the supplied
872+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.IDataReader)" />,
873+
which copies all rows in the supplied
865874
<see cref="T:System.Data.IDataReader" />
866875
to a destination table specified by the
867876
<see cref="P:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName" />
@@ -880,33 +889,41 @@ For more information about asynchronous programming in the .NET Framework Data P
880889
<exception cref="T:System.InvalidOperationException">
881890
Calling
882891
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.IDataReader)" />
883-
multiple times for the same instance before task completion. Calling
892+
multiple times for the same instance before task completion.
893+
894+
Calling
884895
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.IDataReader)" />
885896
and
886897
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.IDataReader)" />
887898
for the same instance before task completion.
899+
888900
The connection drops or is closed during
889901
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.IDataReader)" />
890902
execution.
903+
891904
Returned in the task object, the
892905
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopy" />
893906
object was closed during the method execution.
907+
894908
Returned in the task object, there was a connection pool timeout.
909+
895910
Returned in the task object, the
896911
<see cref="T:Microsoft.Data.SqlClient.SqlConnection" />
897912
object is closed before method execution.
913+
898914
The
899915
<see cref="T:System.Data.IDataReader" />
900916
was closed before the completed
901917
<see cref="T:System.Threading.Tasks.Task" />
902918
returned.
919+
903920
The
904-
<see cref="T:System.Data.IDataReader" />
905-
's associated connection was closed before the completed
921+
<see cref="T:System.Data.IDataReader" />'s associated connection was closed before the completed
906922
<see cref="T:System.Threading.Tasks.Task" />
907923
returned.
908924
<see langword="Context Connection=true" />
909925
is specified in the connection string.
926+
910927
A
911928
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopyColumnOrderHint" />
912929
did not specify a valid destination column name.
@@ -925,24 +942,23 @@ For more information about asynchronous programming in the .NET Framework Data P
925942
The cancellation instruction. A
926943
<see cref="P:System.Threading.CancellationToken.None" />
927944
value in this parameter makes this method equivalent to
928-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.Common.DbDataReader)" />
929-
.
945+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.Common.DbDataReader)" />.
930946
</param>
931947
<summary>
932948
The asynchronous version of
933-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.Common.DbDataReader)" />
934-
, which copies all rows from the supplied
949+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.Common.DbDataReader)" />,
950+
which copies all rows from the supplied
935951
<see cref="T:System.Data.Common.DbDataReader" />
936952
array to a destination table specified by the
937953
<see cref="P:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName" />
938954
property of the
939955
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopy" />
940956
object.
957+
958+
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
941959
</summary>
942960
<returns>
943-
Returns
944-
<see cref="T:System.Threading.Tasks.Task" />
945-
.
961+
A task representing the asynchronous operation.
946962
</returns>
947963
<remarks>
948964
To be added.
@@ -956,8 +972,8 @@ For more information about asynchronous programming in the .NET Framework Data P
956972
</param>
957973
<summary>
958974
The asynchronous version of
959-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.IDataReader)" />
960-
, which copies all rows in the supplied
975+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.IDataReader)" />,
976+
which copies all rows in the supplied
961977
<see cref="T:System.Data.IDataReader" />
962978
to a destination table specified by the
963979
<see cref="P:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName" />
@@ -1007,8 +1023,7 @@ For more information about asynchronous programming in the .NET Framework Data P
10071023
returned.
10081024

10091025
The
1010-
<see cref="T:System.Data.IDataReader" />
1011-
's associated connection was closed before the completed
1026+
<see cref="T:System.Data.IDataReader" />'s associated connection was closed before the completed
10121027
<see cref="T:System.Threading.Tasks.Task" />
10131028
returned.
10141029
<see langword="Context Connection=true" />
@@ -1032,20 +1047,20 @@ For more information about asynchronous programming in the .NET Framework Data P
10321047
The cancellation instruction. A
10331048
<see cref="P:System.Threading.CancellationToken.None" />
10341049
value in this parameter makes this method equivalent to
1035-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataTable)" />
1036-
.
1050+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataTable)" />.
10371051
</param>
10381052
<summary>
10391053
The asynchronous version of
1040-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.IDataReader)" />
1041-
, which copies all rows in the supplied
1054+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.IDataReader)" />,
1055+
which copies all rows in the supplied
10421056
<see cref="T:System.Data.IDataReader" />
10431057
to a destination table specified by the
10441058
<see cref="P:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName" />
10451059
property of the
10461060
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopy" />
10471061
object.
1048-
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
1062+
1063+
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
10491064
</summary>
10501065
<returns>
10511066
A task representing the asynchronous operation.
@@ -1088,8 +1103,7 @@ For more information about asynchronous programming in the .NET Framework Data P
10881103
returned.
10891104

10901105
The
1091-
<see cref="T:System.Data.IDataReader" />
1092-
's associated connection was closed before the completed
1106+
<see cref="T:System.Data.IDataReader" />'s associated connection was closed before the completed
10931107
<see cref="T:System.Threading.Tasks.Task" />
10941108
returned.
10951109
<see langword="Context Connection=true" />
@@ -1111,8 +1125,8 @@ For more information about asynchronous programming in the .NET Framework Data P
11111125
</param>
11121126
<summary>
11131127
The asynchronous version of
1114-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataTable)" />
1115-
, which copies all rows in the supplied
1128+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataTable)" />,
1129+
which copies all rows in the supplied
11161130
<see cref="T:System.Data.DataTable" />
11171131
to a destination table specified by the
11181132
<see cref="P:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName" />
@@ -1160,7 +1174,7 @@ For more information about asynchronous programming in the .NET Framework Data P
11601174
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopyColumnOrderHint" />
11611175
did not specify a valid destination column name.
11621176
</exception>
1163-
<exception cref="T:Microsoft.Data.SqlCient.SqlException">
1177+
<exception cref="T:Microsoft.Data.SqlClient.SqlException">
11641178
Returned in the task object, any error returned by SQL Server that occurred while opening the connection.
11651179
</exception>
11661180
</WriteToServerAsync>
@@ -1174,21 +1188,20 @@ For more information about asynchronous programming in the .NET Framework Data P
11741188
The cancellation instruction. A
11751189
<see cref="P:System.Threading.CancellationToken.None" />
11761190
value in this parameter makes this method equivalent to
1177-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataTable)" />
1178-
.
1191+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataTable)" />.
11791192
</param>
11801193
<summary>
11811194
The asynchronous version of
1182-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataTable)" />
1183-
, which copies all rows in the supplied
1195+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataTable)" />,
1196+
which copies all rows in the supplied
11841197
<see cref="T:System.Data.DataTable" />
11851198
to a destination table specified by the
11861199
<see cref="P:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName" />
11871200
property of the
11881201
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopy" />
11891202
object.
11901203

1191-
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
1204+
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
11921205
</summary>
11931206
<returns>
11941207
A task representing the asynchronous operation.
@@ -1247,8 +1260,7 @@ For more information about asynchronous programming in the .NET Framework Data P
12471260
</param>
12481261
<summary>
12491262
The asynchronous version of
1250-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataTable,System.Data.DataRowState)" />
1251-
,
1263+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataTable,System.Data.DataRowState)" />,
12521264
which copies only rows that match the supplied row state in the supplied
12531265
<see cref="T:System.Data.DataTable" /> to a destination table specified by the <see cref="P:Microsoft.Data.SqlClient.SqlBulkCopy.DestinationTableName" />
12541266
property of the <see cref="T:Microsoft.Data.SqlClient.SqlBulkCopy" /> object.
@@ -1312,13 +1324,11 @@ For more information about asynchronous programming in the .NET Framework Data P
13121324
The cancellation instruction. A
13131325
<see cref="P:System.Threading.CancellationToken.None" />
13141326
value in this parameter makes this method equivalent to
1315-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataTable)" />
1316-
.
1327+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServerAsync(System.Data.DataTable)" />.
13171328
</param>
13181329
<summary>
13191330
The asynchronous version of
1320-
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataTable,System.Data.DataRowState)" />
1321-
,
1331+
<see cref="M:Microsoft.Data.SqlClient.SqlBulkCopy.WriteToServer(System.Data.DataTable,System.Data.DataRowState)" />,
13221332
which copies only rows that match the supplied row state in the supplied
13231333
<see cref="T:System.Data.DataTable" />
13241334
to a destination table specified by the
@@ -1327,7 +1337,7 @@ For more information about asynchronous programming in the .NET Framework Data P
13271337
<see cref="T:Microsoft.Data.SqlClient.SqlBulkCopy" />
13281338
object.
13291339

1330-
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.\
1340+
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
13311341
</summary>
13321342
<returns>
13331343
A task representing the asynchronous operation.

0 commit comments

Comments
 (0)