SqlCommand.CommandText プロパティ

.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

C#

public override string CommandText { get;
 set; }

C++

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

J#

/** @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 

C#

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
SqlCommand クラス
SqlCommand メンバ
System.Data.SqlClient 名前空間
その他の技術情報
ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用