SQLSetCursorName, fonction

Conformité
Version introduite : Conformité aux normes ODBC 1.0 : ISO 92

Résumé
SQLSetCursorName associe un nom de curseur à une instruction active. Si une application n’appelle pas SQLSetCursorName, le pilote génère des noms de curseurs si nécessaire pour le traitement des instructions SQL.

Syntaxe

  
SQLRETURN SQLSetCursorName(  
     SQLHSTMT      StatementHandle,  
     SQLCHAR *     CursorName,  
     SQLSMALLINT   NameLength);  

Arguments

StatementHandle
[Entrée] Handle d’instruction.

CursorName
[Entrée] Nom du curseur. Pour un traitement efficace, le nom du curseur ne doit pas inclure d’espaces de début ou de fin dans le nom du curseur et si le nom du curseur inclut un identificateur délimité, le délimiteur doit être positionné comme premier caractère dans le nom du curseur.

NameLength
[Entrée] Longueur en caractères de *CursorName.

Retours

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR ou SQL_INVALID_HANDLE.

Diagnostics

Lorsque SQLSetCursorName retourne SQL_ERROR ou SQL_SUCCESS_WITH_INFO, une valeur SQLSTATE associée peut être obtenue en appelant SQLGetDiagRec avec un HandleType de SQL_HANDLE_STMT et un Handle of StatementHandle. Le tableau suivant répertorie les valeurs SQLSTATE couramment retournées par SQLSetCursorName et explique chacune d’elles dans le contexte de cette fonction ; la notation « (DM) » précède les descriptions de SQLSTATEs retournées par le Gestionnaire de pilotes. Le code de retour associé à chaque valeur SQLSTATE est SQL_ERROR, sauf indication contraire.

SQLSTATE	Erreur	Description
01000	Avertissement général	Message d’information spécifique au pilote. (La fonction retourne SQL_SUCCESS_WITH_INFO.)
01004	Données de chaîne, tronquées à droite	Le nom du curseur a dépassé la limite maximale, de sorte que seul le nombre maximal autorisé de caractères a été utilisé.
24000	État de curseur non valide	L’instruction correspondant à StatementHandle était déjà dans un état exécuté ou positionné sur le curseur.
34000	Nom de curseur non valide	Le nom du curseur spécifié dans *CursorName n’était pas valide, car il a dépassé la longueur maximale définie par le pilote, ou il a démarré avec « SQLCUR » ou « SQL_CUR ».
3C000	Nom du curseur dupliqué	Le nom du curseur spécifié dans *CursorName existe déjà.
HY000	Erreur générale	Une erreur s’est produite pour laquelle il n’y avait aucun SQLSTATE spécifique et pour lequel aucun SQLSTATE spécifique à l’implémentation n’a été défini. Le message d’erreur retourné par SQLGetDiagRec dans la mémoire tampon *MessageText décrit l’erreur et sa cause.
HY001	Erreur d’allocation de mémoire	Le pilote n’a pas pu allouer de mémoire nécessaire pour prendre en charge l’exécution ou l’achèvement de la fonction.
HY009	Utilisation non valide du pointeur Null	(DM) L’argument CursorName était un pointeur Null.
HY010	Erreur de séquence de fonction	(DM) Une fonction en cours d’exécution asynchrone a été appelée pour le handle de connexion associé à StatementHandle. Cette fonction aynchronous était toujours en cours d’exécution lorsque la fonction SQLSetCursorName a été appelée. (DM) Une fonction en cours d’exécution asynchrone a été appelée pour l’instruction StatementHandle et était toujours en cours d’exécution lors de l’appel de cette fonction. (DM) SQLExecute, SQLExecDirect, SQLBulkOperations ou SQLSetPos a été appelé pour l’instructionHandle et retourné SQL_NEED_DATA. Cette fonction a été appelée avant que les données ne soient envoyées pour tous les paramètres ou colonnes de données à l’exécution.
HY013	Erreur de gestion de la mémoire	L’appel de fonction n’a pas pu être traité, car les objets de mémoire sous-jacents n’ont pas pu être accessibles, éventuellement en raison de conditions de mémoire insuffisantes.
HY090	Longueur de la chaîne ou de la mémoire tampon non valide	(DM) L’argument NameLength était inférieur à 0, mais pas égal à SQL_NTS.
HY117	La connexion est suspendue en raison d’un état de transaction inconnu. Seules les fonctions de déconnexion et de lecture seule sont autorisées.	(DM) Pour plus d’informations sur l’état suspendu, consultez la fonction SQLEndTran.
HYT01	Délai d’attente de la connexion expiré	La période d’expiration de la connexion a expiré avant que la source de données ne réponde à la demande. La période d’expiration de connexion est définie via SQLSetConnectAttr, SQL_ATTR_CONNECTION_TIMEOUT.
IM001	Le pilote ne prend pas en charge cette fonction	(DM) Le pilote associé à StatementHandle ne prend pas en charge la fonction.

Commentaires

Les noms de curseurs sont utilisés uniquement dans les instructions de mise à jour et de suppression positionnées (par exemple, update table-name ...WHERE CURRENT OF cursor-name). Pour plus d’informations, consultez Instructions de mise à jour et de suppression positionnées. Si l’application n’appelle pas SQLSetCursorName pour définir un nom de curseur, lors de l’exécution d’une instruction de requête, le pilote génère un nom qui commence par les lettres SQL_CUR et ne dépasse pas 18 caractères de longueur.

Tous les noms de curseurs au sein de la connexion doivent être uniques. La longueur maximale d’un nom de curseur est définie par le pilote. Pour une interopérabilité maximale, il est recommandé que les applications limitent les noms de curseurs à plus de 18 caractères. Dans ODBC 3*.x*, si un nom de curseur est un identificateur entre guillemets, il est traité de manière sensible à la casse et peut contenir des caractères que la syntaxe de SQL n’autorise pas ou ne traiterait pas spécialement, comme des espaces ou des mots clés réservés. Si un nom de curseur doit être traité de manière sensible à la casse, il doit être transmis en tant qu’identificateur entre guillemets.

Un nom de curseur défini explicitement ou implicitement reste défini jusqu’à ce que l’instruction associée soit supprimée, à l’aide de SQLFreeHandle. SQLSetCursorName peut être appelé pour renommer un curseur sur une instruction tant que le curseur est dans un état alloué ou préparé.

Exemple de code

Dans l’exemple suivant, une application utilise SQLSetCursorName pour définir un nom de curseur pour une instruction. Il utilise ensuite cette instruction pour récupérer les résultats de la table CUSTOMERS. Enfin, il effectue une mise à jour positionnée pour modifier le numéro de téléphone de John Smith. Notez que l’application utilise des handles d’instructions différents pour les instructions SELECT et UPDATE .

Pour obtenir un autre exemple de code, consultez SQLSetPos.

#define NAME_LEN 50  
#define PHONE_LEN 10  
  
SQLHSTMT     hstmtSelect,  
SQLHSTMT     hstmtUpdate;  
SQLRETURN    retcode;  
SQLHDBC      hdbc;  
SQLCHAR      szName[NAME_LEN], szPhone[PHONE_LEN];  
SQLINTEGER   cbName, cbPhone;  
  
/* Allocate the statements and set the cursor name. */  
  
SQLAllocHandle(SQL_HANDLE_STMT, hdbc, &hstmtSelect);  
SQLAllocHandle(SQL_HANDLE_STMT, hdbc, &hstmtUpdate);  
SQLSetCursorName(hstmtSelect, "C1", SQL_NTS);  
  
/* SELECT the result set and bind its columns to local buffers. */  
  
SQLExecDirect(hstmtSelect,  
      "SELECT NAME, PHONE FROM CUSTOMERS",  
      SQL_NTS);  
SQLBindCol(hstmtSelect, 1, SQL_C_CHAR, szName, NAME_LEN, &cbName);  
SQLBindCol(hstmtSelect, 2, SQL_C_CHAR, szPhone, PHONE_LEN, &cbPhone);  
  
/* Read through the result set until the cursor is */  
/* positioned on the row for John Smith. */  
  
do  
 retcode = SQLFetch(hstmtSelect);  
while ((retcode == SQL_SUCCESS || retcode == SQL_SUCCESS_WITH_INFO) &&  
   (strcmp(szName, "Smith, John") != 0));  
  
/* Perform a positioned update of John Smith's name. */  
  
if (retcode == SQL_SUCCESS || retcode == SQL_SUCCESS_WITH_INFO) {  
   SQLExecDirect(hstmtUpdate,  
   "UPDATE EMPLOYEE SET PHONE=\"2064890154\" WHERE CURRENT OF C1",  
   SQL_NTS);  
}  

Fonctions connexes

Pour plus d’informations sur	Consultez
Exécution d’une instruction SQL	SQLExecDirect, fonction
Exécution d’une instruction SQL préparée	SQLExecute, fonction
Retour d’un nom de curseur	SQLGetCursorName, fonction
Définition des options de défilement du curseur	SQLSetScrollOptions, fonction

Voir aussi

Informations de référence sur l’API ODBC
Fichiers d’en-tête ODBC