sqlsrv_cancel

Artigo
06/02/2023

Cancela uma instrução. Isso significa que qualquer resultado pendente para a instrução será descartado. Depois que essa função for chamada, a instrução poderá ser executada novamente se ela tiver sido preparada com sqlsrv_prepare. Não é necessário chamar essa função se todos os resultados associados à instrução tiverem sido consumidos.

Sintaxe

  
sqlsrv_cancel( resource $stmt)

Parâmetros

$stmt: A instrução a ser cancelada.

Valor Retornado

Um valor booliano: true se a operação foi bem-sucedida. Caso contrário, false.

Exemplo

O exemplo a seguir tem como alvo o banco de dados AdventureWorks para executar uma consulta, em seguida, consome e conta os resultados até que a variável $salesTotal atinja um valor especificado. Os resultados da consulta restantes são, então, descartados. O exemplo supõe que o SQL Server e o banco de dados AdventureWorks estejam instalados no computador local. Toda a saída será gravada no console quando o exemplo for executado da linha de comando.

<?php  
/* Connect to the local server using Windows Authentication and   
specify the AdventureWorks database as the database in use. */  
$serverName = "(local)";  
$connectionInfo = array( "Database"=>"AdventureWorks");  
$conn = sqlsrv_connect( $serverName, $connectionInfo);  
if( $conn === false )  
{  
     echo "Could not connect.\n";  
     die( print_r( sqlsrv_errors(), true));  
}  
  
/* Prepare and execute the query. */  
$tsql = "SELECT OrderQty, UnitPrice FROM Sales.SalesOrderDetail";  
$stmt = sqlsrv_prepare( $conn, $tsql);  
if( $stmt === false )  
{  
     echo "Error in statement preparation.\n";  
     die( print_r( sqlsrv_errors(), true));  
}  
if( sqlsrv_execute( $stmt ) === false)  
{  
     echo "Error in statement execution.\n";  
     die( print_r( sqlsrv_errors(), true));  
}  
  
/* Initialize tracking variables. */  
$salesTotal = 0;  
$count = 0;  
  
/* Count and display the number of sales that produce revenue  
of $100,000. */  
while( ($row = sqlsrv_fetch_array( $stmt)) && $salesTotal <=100000)  
{  
     $qty = $row[0];  
     $price = $row[1];  
     $salesTotal += ( $price * $qty);  
     $count++;  
}  
echo "$count sales accounted for the first $$salesTotal in revenue.\n";  
  
/* Cancel the pending results. The statement can be reused. */  
sqlsrv_cancel( $stmt);  
?>

Comentários

Uma instrução preparada e executada usando a combinação de sqlsrv_prepare e sqlsrv_execute pode ser executada novamente com sqlsrv_execute depois de chamar sqlsrv_cancel. Uma instrução executada com sqlsrv_query não pode ser executada novamente depois de chamar sqlsrv_cancel.