Share via


SqlCommandBuilder.DeriveParameters(SqlCommand) Method

Definition

Retrieves parameter information from the stored procedure specified in the SqlCommand and populates the Parameters collection of the specified SqlCommand object.

public:
 static void DeriveParameters(Microsoft::Data::SqlClient::SqlCommand ^ command);
public static void DeriveParameters (Microsoft.Data.SqlClient.SqlCommand command);
static member DeriveParameters : Microsoft.Data.SqlClient.SqlCommand -> unit
Public Shared Sub DeriveParameters (command As SqlCommand)

Parameters

command
SqlCommand

The SqlCommand referencing the stored procedure from which the parameter information is to be derived. The derived parameters are added to the Parameters collection of the SqlCommand.

Exceptions

The command text is not a valid stored procedure name.

Remarks

DeriveParameters overwrites any existing parameter information for the SqlDbCommand.

DeriveParameters requires an additional call to the database to obtain the information. If the parameter information is known in advance, it is more efficient to populate the parameters collection by setting the information explicitly.

You can only use DeriveParameters with stored procedures. You cannot use DeriveParameters with extended stored procedures. You cannot use DeriveParameters to populate the SqlParameterCollection with arbitrary Transact-SQL statements, such as a parameterized SELECT statement.

For more information, see Configuring parameters.

Applies to