sp_cursor_list (Transact-SQL)

構文

sp_cursor_list [ @cursor_return = ] cursor_variable_name OUTPUT 
          , [ @cursor_scope = ] cursor_scope

引数

• [ @cursor_return = ] cursor_variable_nameOUTPUT
  宣言されているカーソル変数の名前を指定します。cursor_variable_name のデータ型は cursor で、既定値はありません。カーソルはスクロール可能、動的、読み取り専用カーソルのいずれかです。

• [ @cursor_scope = ] cursor_scope
  レポートするカーソルのレベルを指定します。cursor_scope のデータ型は int で、既定値はありません。次のいずれかの値を指定できます。

  値	説明
  1	すべてのローカル カーソルをレポートします。
  2	すべてのグローバル カーソルをレポートします。
  3	ローカル カーソルとグローバル カーソルの両方をレポートします。

戻り値

なし

返されるカーソル

sp_cursor_list は、結果セットとしてではなく、Transact-SQL カーソル出力パラメータとしてレポートを返します。このため、Transact-SQL バッチ、ストアド プロシージャ、およびトリガは、一度に 1 行ずつ、出力を処理できます。また、データベース API 関数からプロシージャを直接呼び出すことができなくなります。カーソル出力パラーメータはプログラム変数にバインドする必要がありますが、データベース API では、カーソル パラメータまたは変数のバインドがサポートされません。

以下は、sp_cursor_list から返されるカーソルの形式です。このカーソルの形式は、sp_describe_cursor から返される形式と同じです。

説明

sp_cursor_list は、接続によってオープンされた現在のサーバー カーソルの一覧を作成し、カーソルのスクロール機能や更新機能など、各カーソルにとってグローバルな属性を示します。sp_cursor_list によってレポートされるカーソルは次のとおりです。

• Transact-SQL サーバー カーソル。

• ODBC アプリケーションによってオープンされた API サーバー カーソル。この後、カーソルに名前を付けるために、SQLSetCursorName が呼び出されます。

カーソルから返された結果セットの属性の説明が必要な場合は、sp_describe_cursor_columns を使用します。カーソルから参照されるベース テーブルのレポートが必要な場合は、sp_describe_cursor_tables を使用します。sp_describe_cursor は、指定された 1 つのカーソルに関してだけ sp_cursor_list と同じ情報を返します。

権限

実行権限は、特に指定のない限りロール public に与えられます。

例

次の例では、グローバル カーソルをオープンし、sp_cursor_list を使用してカーソルの属性をレポートします。

USE AdventureWorks
GO
-- Declare and open a keyset-driven cursor.
DECLARE abc CURSOR KEYSET FOR
SELECT LastName
FROM Person.Contact
WHERE LastName LIKE 'S%'
OPEN abc

-- Declare a cursor variable to hold the cursor output variable
-- from sp_cursor_list.
DECLARE @Report CURSOR

-- Execute sp_cursor_list into the cursor variable.
EXEC master.dbo.sp_cursor_list @cursor_return = @Report OUTPUT,
      @cursor_scope = 2

-- Fetch all the rows from the sp_cursor_list output cursor.
FETCH NEXT from @Report
WHILE (@@FETCH_STATUS <> -1)
BEGIN
   FETCH NEXT from @Report
END

-- Close and deallocate the cursor from sp_cursor_list.
CLOSE @Report
DEALLOCATE @Report
GO

-- Close and deallocate the original cursor.
CLOSE abc
DEALLOCATE abc
GO

関連項目

参照