sp_cursoroption (Transact-SQL)

Aplica-se a: SQL Server

Define as opções do cursor ou retorna as informações do cursor criadas pelo procedimento armazenado sp_cursoropen. sp_cursoroption é invocado especificando ID =8 em um pacote TDS (fluxo de dados tabular).

Convenções de sintaxe de Transact-SQL

Sintaxe

  
sp_cursoroption cursor, code, value  

Argumentos

cursor
É um valor de identificador gerado pelo SQL Server e retornado pelo procedimento armazenado sp_cursoropen. cursor requer um valor de entrada int para execução.

code
Usado para estipular vários fatores dos valores de retorno de cursor. O código requer um dos seguintes valores de entrada int :

Valor	Nome	Descrição
0x0001	TEXTPTR_ONLY	Retorna o ponteiro de texto, e não os dados reais, para certos textos designados ou colunas de imagem. TEXTPTR_ONLY permite que ponteiros de texto sejam usados como identificadores para objetos blob que podem ser recuperados ou atualizados seletivamente posteriormente usando recursos Transact-SQL ou DBLIB (por exemplo, Transact-SQL READTEXT ou DBLIB DBWRITETEXT). Se um valor "0" for atribuído, todas as colunas de texto e imagem na lista selecionada retornarão ponteiros de texto, em vez de dados.
0x0002	CURSOR_NAME	Atribui o nome especificado em valor ao cursor. Isso, por sua vez, permite que o ODBC use instruções UPDATE/DELETE posicionadas pelo Transact-SQL em cursores abertos por meio sp_cursoropen. É possível especificar a cadeia de caracteres como qualquer tipo de dados de caractere ou Unicode. Como as instruções UPDATE/DELETE posicionadas pelo Transact-SQL operam, por padrão, na primeira linha em um cursor gordo, sp_cursor SETPOSITION deve ser usada para posicionar o cursor antes de emitir a instrução UPDATE/DELETE posicionada.
0x0003	TEXTDATA	Retorna os dados reais, não o ponteiro de texto, para certas colunas de texto ou imagem em buscas subsequentes (isto é, desfaz o efeito de TEXTPTR_ONLY). Se TEXTDATA for habilitado para uma coluna específica, a linha será buscada novamente ou atualizada e poderá ser definida outra vez como TEXTPTR_ONLY. Assim como ocorre com TEXTPTR_ONLY, o parâmetro de valor é um inteiro que especifica o número da coluna e um valor de zero retorna todas as colunas de texto ou imagem.
0x0004	SCROLLOPT	Opção de rolagem. Consulte "Valores de códigos retornados" posteriormente neste tópico para obter informações adicionais.
0x0005	CCOPT	Opção de controle de simultaneidade. Consulte "Valores de códigos retornados" posteriormente neste tópico para obter informações adicionais.
0x0006	ROWCOUNT	O número de linhas atualmente no conjunto de resultados. Observação: o ROWCOUNT pode ter sido alterado, pois o valor retornado por sp_cursoropen se a população assíncrona estiver sendo usada. O valor -1 será retornado se o número de linhas for desconhecido.

value
Designa o valor retornado pelo código. value é um parâmetro obrigatório que chama um valor de entrada de código 0x0001, 0x0002 ou 0x0003.

Observação

Um valor de código de 2 é um tipo de dados de cadeia de caracteres. Qualquer outro valor de código inserido ou retornado por valor é um número inteiro.

Valores do código de retorno

O parâmetro value pode retornar um dos seguintes valores de código .

Valor retornado	Descrição
0x0004	SCROLLOPT
0X0005	CCOPT
0X0006	ROWCOUNT

O parâmetro value retorna um dos seguintes valores SCROLLOPT.

Valor retornado	Descrição
0x0001	KEYSET
0x0002	DYNAMIC
0x0004	FORWARD_ONLY
0x0008	STATIC

O parâmetro value retorna um dos seguintes valores CCOPT.

Valor retornado	Descrição
0x0001	READ_ONLY
0x0002	SCROLL_LOCKS
0x0004 ou 0x0008	OPTIMISTIC

Confira também

Procedimentos armazenados do sistema (Transact-SQL)
sp_cursor (Transact-SQL)
sp_cursoropen (Transact-SQL)