Récapitulatif des fonctions ODBC
Le tableau suivant répertorie les fonctions ODBC, regroupées par type de tâche, et inclut la désignation de conformité et une brève description de l’objectif de chaque fonction. Pour plus d’informations sur les désignations de conformité, consultez ODBC et l’interface CLI Standard. Pour plus d’informations sur la syntaxe et la sémantique de chaque fonction, consultez la référence de l’API ODBC.
Une application peut appeler la fonction SQLGetInfo pour obtenir des informations de conformité sur un pilote. Pour obtenir des informations sur la prise en charge d’une fonction spécifique dans un pilote, une application peut appeler SQLGetFunctions.
| Tâche | Nom de la fonction | Conformité | Objectif |
|---|---|---|---|
| Connexion à une source de données | SQLAllocHandle | ISO 92 | Obtient un handle d’environnement, de connexion, d’instruction ou de descripteur. |
| SQLConnect | ISO 92 | Se connecte à un pilote spécifique par nom de source de données, ID d’utilisateur et mot de passe. | |
| SQLDriverConnect | ODBC | Se connecte à un pilote spécifique par chaîne de connexion ou demande que le Gestionnaire de pilotes et le pilote affichent les boîtes de dialogue de connexion de l’utilisateur. | |
| SQLBrowseConnect | ODBC | Retourne les niveaux successifs d’attributs de connexion et les valeurs d’attribut valides. Lorsqu’une valeur a été spécifiée pour chaque attribut de connexion, se connecte à la source de données. | |
| Obtention d’informations sur un pilote et une source de données | SQLDataSources SQLDrivers |
ISO 92 ODBC |
Retourne la liste des sources de données disponibles. Retourne la liste des pilotes installés et de leurs attributs. |
| SQLGetInfo | ISO 92 | Retourne des informations sur un pilote et une source de données spécifiques. | |
| SQLGetFunctions | ISO 92 | Retourne les fonctions de pilote prises en charge. | |
| SQLGetTypeInfo | ISO 92 | Retourne des informations sur les types de données pris en charge. | |
| Définition et récupération des attributs de pilote | SQLSetConnectAttr SQLGetConnectAttr |
ISO 92 ISO 92 |
Définit un attribut de connexion. Retourne la valeur d’un attribut de connexion. |
| SQLSetEnvAttr | ISO 92 | Définit un attribut d’environnement. | |
| SQLGetEnvAttr | ISO 92 | Retourne la valeur d’un attribut d’environnement. | |
| SQLSetStmtAttr | ISO 92 | Définit un attribut d’instruction. | |
| SQLGetStmtAttr | ISO 92 | Retourne la valeur d’un attribut d’instruction. | |
| Définition et récupération des champs de descripteur | SQLGetDescField SQLGetDescRec |
ISO 92 ISO 92 |
Retourne la valeur d’un seul champ de descripteur. Retourne les valeurs de plusieurs champs de descripteur. |
| SQLSetDescField | ISO 92 | Définit un seul champ de descripteur. | |
| SQLSetDescRec | ISO 92 | Définit plusieurs champs de descripteur. | |
| SQLCopyDesc | ISO 92 | Copie les informations de descripteur d’un handle de descripteur vers une autre. | |
| Préparation des requêtes SQL | SQLPrepare | ISO 92 | Prépare une instruction SQL pour une exécution ultérieure. |
| SQLBindParameter | ODBC | Affecte le stockage d’un paramètre dans une instruction SQL. | |
| SQLGetCursorName | ISO 92 | Retourne le nom du curseur associé à un handle d’instruction. | |
| SQLSetCursorName | ISO 92 | Spécifie un nom de curseur. | |
| SQLSetScrollOptions | ODBC | Définit les options qui contrôlent le comportement du curseur. | |
| Envoi des demandes | SQLExecute SQLExecDirect |
ISO 92 ISO 92 |
Exécute une instruction préparée. Exécute une instruction. |
| SQLNativeSql | ODBC | Retourne le texte d’une instruction SQL tel qu’il est traduit par le pilote. | |
| SQLDescribeParam | ODBC | Retourne la description d’un paramètre spécifique dans une instruction. | |
| SQLNumParams | ISO 92 | Retourne le nombre de paramètres dans une instruction. | |
| SQLParamData | ISO 92 | Utilisé conjointement avec SQLPutData pour fournir des données de paramètre au moment de l’exécution. (Utile pour les valeurs de données longues.) | |
| SQLPutData | ISO 92 | Envoie une partie ou l’ensemble d’une valeur de données pour un paramètre. (Utile pour les valeurs de données longues.) | |
| Récupération des résultats et des informations sur les résultats | SQLRowCount SQLNumResultCols |
ISO 92 ISO 92 |
Retourne le nombre de lignes affectées par une demande d’insertion, de mise à jour ou de suppression. Retourne le nombre de colonnes dans le jeu de résultats. |
| SQLDescribeCol | ISO 92 | Décrit une colonne dans le jeu de résultats. | |
| SQLColAttribute | ISO 92 | Décrit les attributs d’une colonne dans le jeu de résultats. | |
| SQLBindCol | ISO 92 | Affecte le stockage pour une colonne de résultat et spécifie le type de données. | |
| SQLFetch | ISO 92 | Retourne plusieurs lignes de résultat. | |
| SQLFetchScroll | ISO 92 | Retourne des lignes de résultats défilantes. | |
| SQLGetData | ISO 92 | Retourne une partie ou l’ensemble d’une colonne d’une ligne d’un jeu de résultats. (Utile pour les valeurs de données longues.) | |
| SQLSetPos | ODBC | Positionne un curseur dans un bloc de données extrait et permet à une application d’actualiser les données dans l’ensemble de lignes ou de mettre à jour ou de supprimer des données dans le jeu de résultats. | |
| SQLBulkOperations | ODBC | Effectue des insertions en bloc et des opérations de signet en bloc, notamment les opérations de mise à jour, de suppression et d’extraction par signet. | |
| SQLMoreResults | ODBC | Détermine s’il existe davantage de jeux de résultats disponibles et, le cas échéant, initialise le traitement pour le jeu de résultats suivant. | |
| SQLGetDiagField | ISO 92 | Retourne des informations de diagnostic supplémentaires (un champ unique de la structure des données de diagnostic). | |
| SQLGetDiagRec | ISO 92 | Retourne des informations de diagnostic supplémentaires (plusieurs champs de la structure des données de diagnostic). | |
| Obtention d’informations sur les tables système de la source de données (fonctions de catalogue) | SQLColumnPrivileges SQLColumns |
ODBC Ouvrir le groupe |
Retourne une liste de colonnes et de privilèges associés pour une ou plusieurs tables. Retourne la liste des noms de colonnes dans les tables spécifiées. |
| SQLForeignKeys | ODBC | Retourne une liste de noms de colonnes qui composent des clés étrangères, s’ils existent pour une table spécifiée. | |
| SQLPrimaryKeys | ODBC | Retourne la liste des noms de colonnes qui composent la clé primaire d’une table. | |
| SQLProcedureColumns | ODBC | Retourne la liste des paramètres d’entrée et de sortie, ainsi que les colonnes qui composent le jeu de résultats pour les procédures spécifiées. | |
| SQLProcedures | ODBC | Retourne la liste des noms de procédure stockés dans une source de données spécifique. | |
| SQLSpecialColumns | Ouvrir le groupe | Retourne des informations sur l’ensemble optimal de colonnes qui identifient de manière unique une ligne dans une table spécifiée ou les colonnes qui sont automatiquement mises à jour quand une valeur de la ligne est mise à jour par une transaction. | |
| SQLStatistics | ISO 92 | Retourne des statistiques sur une table unique et la liste des index associés à la table. | |
| SQLTablePrivileges | ODBC | Retourne une liste de tables et les privilèges associés à chaque table. | |
| SQLTables | Ouvrir le groupe | Retourne la liste des noms de tables stockés dans une source de données spécifique. | |
| Fin d’une instruction | SQLFreeStmt | ISO 92 | Met fin au traitement des instructions, ignore les résultats en attente et libère éventuellement toutes les ressources associées au handle d’instruction. |
| SQLCloseCursor | ISO 92 | Ferme un curseur ouvert sur un handle d’instruction. | |
| SQLCancel | ISO 92 | Annule le traitement sur une instruction. | |
| SQLCancelHandle | ODBC | Annule le traitement sur une instruction ou une connexion. | |
| SQLEndTran | ISO 92 | Valide ou restaure une transaction. | |
| Fin d’une connexion | SQLDisconnect SQLFreeHandle |
ISO 92 ISO 92 |
Ferme la connexion. Libère un handle d’environnement, de connexion, d’instruction ou de descripteur. |