SqlNotificationRequest

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

SqlNotificationRequest クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

指定したコマンドに対する通知の要求を表します。

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

Visual Basic (宣言)

Public NotInheritable Class
 SqlNotificationRequest

Visual Basic (使用法)

Dim instance As SqlNotificationRequest

C#

public sealed class SqlNotificationRequest

C++

public ref class SqlNotificationRequest sealed

J#

public final class SqlNotificationRequest

JScript

public final class SqlNotificationRequest

解説

このクラスは、SQL Server 2005 によって公開されるクエリ通知サービスへの低レベルのアクセスを提供します。ほとんどのアプリケーションで、クエリ通知を使用する、より簡単な方法として、SqlDependency クラスを利用できます。ただし、通知が発生したときに詳細な制御が必要な場合や、通知の一部として返されるメッセージ データのカスタマイズが必要な場合には、SqlNotificationRequest クラスを使用してください。

継承階層

System.Object
  System.Data.Sql.SqlNotificationRequest

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
SqlNotificationRequest メンバ
System.Data.Sql 名前空間
その他の技術情報
クエリ通知機能の使用

SqlNotificationRequest コンストラクタ ()

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

既定値を使用して SqlNotificationRequest クラスの新しいインスタンスを作成します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New SqlNotificationRequest

C#

public SqlNotificationRequest ()

C++

public:
SqlNotificationRequest ()

J#

public SqlNotificationRequest ()

JScript

public function SqlNotificationRequest ()

解説

既定のコンストラクタを使用して SqlNotificationRequest オブジェクトを作成する場合、オブジェクトを SqlCommand オブジェクトの Notification プロパティに割り当てる前に、そのインスタンスの UserData プロパティと Options プロパティを初期化しておく必要があります。コンストラクタで使用される既定値は、UserData では NULL (Visual Basic の場合は Nothing)、Options では空の文字列、また Timeout では 0 です。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
SqlNotificationRequest クラス
SqlNotificationRequest メンバ
System.Data.Sql 名前空間
その他の技術情報
クエリ通知機能の使用

SqlNotificationRequest コンストラクタ (String, String, Int32)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

特定の通知要求、定義済みの SQL Server 2005 Service Broker のサービス名、および秒単位で計測されるタイムアウト期限を指定するユーザー定義の文字列を使用して、SqlNotificationRequest クラスの新しいインスタンスを作成します。

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

Visual Basic (宣言)

Public Sub New ( _
    userData As String, _
    options As String, _
    timeout As Integer _
)

Visual Basic (使用法)

Dim userData As String
Dim options As String
Dim timeout As Integer

Dim instance As New SqlNotificationRequest(userData,
 options, timeout)

C#

public SqlNotificationRequest (
    string userData,
    string options,
    int timeout
)

C++

public:
SqlNotificationRequest (
    String^ userData, 
    String^ options, 
    int timeout
)

J#

public SqlNotificationRequest (
    String userData, 
    String options, 
    int timeout
)

JScript

public function SqlNotificationRequest (
    userData : String, 
    options : String, 
    timeout : int
)

パラメータ

userData

この通知に対するアプリケーション固有の ID が含まれる文字列。これは通知のインフラストラクチャでは使用されませんが、これによって通知をアプリケーション状態に関連付けることができます。このパラメータが示す値は、Service Broker のキュー メッセージに含まれます。

options

通知メッセージのポストが行われる Service Broker のサービス名が含まれる文字列。この文字列には、サービス名検索のスコープを特定のデータベースに制限するデータベース名、または Service Broker インスタンスの GUID が含まれる必要があります。

options パラメータの形式の詳細については、Options のトピックを参照してください。

timeout

通知メッセージの待機時間 (秒)。

例外

例外の種類	条件
ArgumentNullException	options パラメータの値が NULL です。
InvalidArgumentException	options パラメータまたは userData パラメータが uint16.MaxValue を超えています。
ArgumentOutOfRangeException	timeout パラメータの値が 0 未満です。

解説

このコンストラクタにより、独自の ID、SQL Server 2005 Service Broker のサービス名、およびタイムアウト値を指定して、新しい SqlNotificationRequest インスタンスを初期化できます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
SqlNotificationRequest クラス
SqlNotificationRequest メンバ
System.Data.Sql 名前空間
その他の技術情報
クエリ通知機能の使用

SqlNotificationRequest コンストラクタ

SqlNotificationRequest クラスの新しいインスタンスを作成します。
オーバーロードの一覧

名前	説明
SqlNotificationRequest ()	既定値を使用して SqlNotificationRequest クラスの新しいインスタンスを作成します。
SqlNotificationRequest (String, String, Int32)	特定の通知要求、定義済みの SQL Server 2005 Service Broker のサービス名、および秒単位で計測されるタイムアウト期限を指定するユーザー定義の文字列を使用して、SqlNotificationRequest クラスの新しいインスタンスを作成します。

参照

関連項目

SqlNotificationRequest クラス
SqlNotificationRequest メンバ
System.Data.Sql 名前空間

その他の技術情報

クエリ通知機能の使用

SqlNotificationRequest プロパティ

パブリック プロパティ

	名前	説明
	Options	通知メッセージのポストが行われる SQL Server Service Broker のサービス名を取得または設定します。
	Timeout	操作がタイムアウトになるまでにSQL Server が変更の発生を待機する時間を指定する値を取得または設定します。
	UserData	この通知に対するアプリケーション固有の ID を取得または設定します。

参照

関連項目

SqlNotificationRequest クラス
System.Data.Sql 名前空間

その他の技術情報

クエリ通知機能の使用

SqlNotificationRequest メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

SqlNotificationRequest クラス
System.Data.Sql 名前空間

その他の技術情報

クエリ通知機能の使用

SqlNotificationRequest メンバ

指定したコマンドに対する通知の要求を表します。

SqlNotificationRequest データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	SqlNotificationRequest	オーバーロードされます。 SqlNotificationRequest クラスの新しいインスタンスを作成します。

パブリック プロパティ

	名前	説明
	Options	通知メッセージのポストが行われる SQL Server Service Broker のサービス名を取得または設定します。
	Timeout	操作がタイムアウトになるまでにSQL Server が変更の発生を待機する時間を指定する値を取得または設定します。
	UserData	この通知に対するアプリケーション固有の ID を取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

SqlNotificationRequest クラス
System.Data.Sql 名前空間

その他の技術情報

クエリ通知機能の使用