SqlCommand.CommandText プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

SqlCommand.CommandText プロパティ

データソースで実行する Transact-SQL ステートメントまたはストアドプロシージャを取得または設定します。

名前空間: System.Data.SqlClient
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Overrides Property
 CommandText As String

Visual Basic (使用法)

Dim instance As SqlCommand
Dim value As String

value = instance.CommandText

instance.CommandText = value

public override string CommandText { get;
 set; }

C++

public:
virtual property String^ CommandText {
    String^ get () override;
    void set (String^ value) override;
}

/** @property */
public String get_CommandText ()

/** @property */
public void set_CommandText (String value)

JScript

public override function get
 CommandText () : String

public override function set
 CommandText (value : String)

プロパティ値
実行する Transact-SQL ステートメントまたはストアドプロシージャ。既定値は空の文字列です。

解説

CommandType プロパティを StoredProcedure に設定したときは、CommandText プロパティをストアドプロシージャ名に設定する必要があります。ストアドプロシージャ名に特殊文字が含まれる場合、ユーザーはエスケープ文字の構文を使用する必要があります。Execute メソッドの 1 つを呼び出すと、コマンドがこのストアドプロシージャを実行します。

Microsoft .NET Framework SQL Server 用データプロバイダでは、CommandType.Text のコマンドで呼び出す Transact-SQL ステートメントまたはストアドプロシージャにパラメータを渡すために、疑問符 (?) のプレースホルダは利用できません。この場合は、名前付きパラメータを使用する必要があります。次に例を示します。

 SELECT * FROM dbo.Customers WHERE CustomerID = @CustomerID

詳細については、「コマンドによるストアドプロシージャの使用」を参照してください。

使用例

SqlCommand を作成し、そのプロパティの一部を設定する例を次に示します。

Visual Basic

Public Sub CreateCommand()
    Dim command As New SqlCommand()
    command.CommandText = "SELECT * FROM Categories ORDER BY CategoryID"
    command.CommandTimeout = 15
    command.CommandType = CommandType.Text
End Sub

public void CreateCommand() 
 {
    SqlCommand command = new SqlCommand();
    command.CommandText = "SELECT * FROM Categories ORDER BY CategoryID";
    command.CommandTimeout = 15;
    command.CommandType = CommandType.Text;
 }