SQLProcedureColumns, fonction
conformité
Version introduite : Conformité aux normes ODBC 1.0 : ODBC
résumé
SQLProcedureColumns 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. Le pilote retourne les informations sous la forme d’un jeu de résultats sur l’instruction spécifiée.
Syntaxe
SQLRETURN SQLProcedureColumns(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3,
SQLCHAR * ColumnName,
SQLSMALLINT NameLength4);
Arguments
StatementHandle
[Entrée] Handle d’instruction.
catalogName
[Entrée] Nom du catalogue de procédures. Si un pilote prend en charge les catalogues pour certaines procédures, mais pas pour d’autres, par exemple lorsque le pilote récupère des données à partir de différents SGBD, une chaîne vide (« ») indique ces procédures qui n’ont pas de catalogues.
catalogName ne peut pas contenir de modèle de recherche de chaîne.
Si l’attribut d’instruction SQL_ATTR_METADATA_ID est défini sur SQL_TRUE, catalogName est traité comme un identificateur et son cas n’est pas significatif. S’il est SQL_FALSE, CatalogName est un argument ordinaire ; il est traité littéralement, et son cas est significatif. Pour plus d’informations, consultez arguments dans les fonctions de catalogue.
NameLength1
[Entrée] Longueur en caractères de *CatalogName.
SchemaName
[Entrée] Modèle de recherche de chaîne pour les noms de schéma de procédure. Si un pilote prend en charge les schémas pour certaines procédures, mais pas pour d’autres, par exemple lorsque le pilote récupère des données à partir de SGBD différents, une chaîne vide (« ») indique ces procédures qui n’ont pas de schémas.
Si l’attribut d’instruction SQL_ATTR_METADATA_ID est défini sur SQL_TRUE, SchemaName est traité comme un identificateur et son cas n’est pas significatif. S’il est SQL_FALSE, SchemaName est un argument de valeur de modèle ; il est traité littéralement, et son cas est significatif.
NameLength2
[Entrée] Longueur en caractères de *SchemaName.
ProcName
[Entrée] Modèle de recherche de chaîne pour les noms de procédure.
Si l’attribut d’instruction SQL_ATTR_METADATA_ID est défini sur SQL_TRUE, ProcName est traité comme un identificateur et son cas n’est pas significatif. S’il s’agit d’un SQL_FALSE, ProcName est un argument de valeur de modèle ; il est traité littéralement, et son cas est significatif.
NameLength3
[Entrée] Longueur en caractères de *ProcName.
ColumnName
[Entrée] Modèle de recherche de chaîne pour les noms de colonnes.
Si l’attribut d’instruction SQL_ATTR_METADATA_ID est défini sur SQL_TRUE, ColumnName est traité comme un identificateur et son cas n’est pas significatif. S’il est SQL_FALSE, columnName est un argument de valeur de modèle ; il est traité littéralement, et son cas est significatif.
NameLength4
[Entrée] Longueur en caractères de *ColumnName.
Retourne
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR ou SQL_INVALID_HANDLE.
Diagnostic
Lorsque SQLProcedureColumns 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 Handle de StatementHandle. Le tableau suivant répertorie les valeurs SQLSTATE couramment retournées par SQLProcedureColumns et explique chacune d’elles dans le contexte de cette fonction ; la notation « (DM) » précède les descriptions des 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.) |
| 08S01 | Échec du lien de communication | Le lien de communication entre le pilote et la source de données à laquelle le pilote a été connecté a échoué avant l’achèvement du traitement de la fonction. |
| 24000 | État du curseur non valide | Un curseur a été ouvert sur lestatementHandle Un curseur a été ouvert sur le |
| 40001 | Échec de sérialisation | La transaction a été restaurée en raison d’un interblocage de ressources avec une autre transaction. |
| 40003 | Saisie semi-automatique de l’instruction inconnue | La connexion associée a échoué pendant l’exécution de cette fonction et l’état de la transaction ne peut pas être déterminé. |
| 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 SQLError 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. |
| HY008 | Opération annulée | Le traitement asynchrone a été activé pour leStatementHandle La fonction a été appelée, et avant qu’elle ait terminé l’exécution, |
| HY009 | Utilisation non valide du pointeur Null | L’attribut d’instruction SQL_ATTR_METADATA_ID a été défini sur SQL_TRUE, l’argument CatalogName était un pointeur Null, et le SQL_CATALOG_NAME InfoType retourne les noms de catalogue pris en charge. (DM) L’attribut d’instruction SQL_ATTR_METADATA_ID a été défini sur SQL_TRUE, et l’argument SchemaName, ProcNameou argument ColumnName é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é au StatementHandle. Cette fonction asynchrone était toujours en cours d’exécution lorsque la fonction SQLProcedureColumns a été appelée. (DM) (DM) Une fonction en cours d’exécution asynchrone (et non celle-ci) a été appelée pour l' statementHandle (DM) |
| HY090 | Longueur de la chaîne ou de la mémoire tampon non valide | (DM) La valeur de l’un des arguments de longueur de nom était inférieure à 0, mais pas égale à SQL_NTS. La valeur de l’un des arguments de longueur de nom a dépassé la valeur de longueur maximale du catalogue, du schéma, de la procédure ou du nom de colonne correspondant. |
| 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 fonction SQLEndTran. |
| HYC00 | Fonctionnalité facultative non implémentée | Un catalogue de procédures a été spécifié et le pilote ou la source de données ne prend pas en charge les catalogues. Un schéma de procédure a été spécifié et le pilote ou la source de données ne prend pas en charge les schémas. Un modèle de recherche de chaîne a été spécifié pour le schéma de procédure, le nom de procédure ou le nom de colonne, et la source de données ne prend pas en charge les modèles de recherche pour un ou plusieurs de ces arguments. La combinaison des paramètres actuels des attributs d’instruction SQL_ATTR_CONCURRENCY et SQL_ATTR_CURSOR_TYPE n’a pas été prise en charge par le pilote ou la source de données. L’attribut d’instruction SQL_ATTR_USE_BOOKMARKS a été défini sur SQL_UB_VARIABLE, et l’attribut d’instruction SQL_ATTR_CURSOR_TYPE a été défini sur un type de curseur pour lequel le pilote ne prend pas en charge les signets. |
| HYT00 | Expiration du délai d’expiration | La période d’expiration a expiré avant que la source de données ne retourne le jeu de résultats. La période d’expiration est définie via SQLSetStmtAttr, SQL_ATTR_QUERY_TIMEOUT. |
| HYT01 | Expiration du délai d’expiration de la connexion | 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 la connexion est définie via SQLSetConnectAttr, SQL_ATTR_CONNECTION_TIMEOUT. |
| IM001 | Le pilote ne prend pas en charge cette fonction | (DM) Le pilote associé au StatementHandle |
| IM017 | L’interrogation est désactivée en mode de notification asynchrone | Chaque fois que le modèle de notification est utilisé, l’interrogation est désactivée. |
| IM018 | SQLCompleteAsync n’a pas été appelé pour terminer l’opération asynchrone précédente sur ce handle. | Si l’appel de fonction précédent sur le handle retourne SQL_STILL_EXECUTING et si le mode de notification est activé, SQLCompleteAsync doit être appelé sur le handle pour effectuer un post-traitement et terminer l’opération. |
Commentaires
Cette fonction est généralement utilisée avant l’exécution de l’instruction pour récupérer des informations sur les paramètres de procédure et les colonnes qui composent le jeu de résultats ou les jeux retournés par la procédure, le cas échéant. Pour plus d’informations, consultez Procédures.
Note
SQLProcedureColumns peut ne pas retourner toutes les colonnes utilisées par une procédure. Par exemple, un pilote peut retourner uniquement des informations sur les paramètres utilisés par une procédure et non les colonnes d’un jeu de résultats qu’il génère.
Les argumentsSchemaName
Note
Pour plus d’informations sur l’utilisation générale, les arguments et les données retournées des fonctions de catalogue ODBC, consultez Fonctions de catalogue.
SQLProcedureColumns retourne les résultats sous la forme d’un jeu de résultats standard, classé par PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME et COLUMN_TYPE. Les noms de colonnes sont retournés pour chaque procédure dans l’ordre suivant : nom de la valeur de retour, noms de chaque paramètre dans l’appel de procédure (dans l’ordre des appels), puis les noms de chaque colonne dans le jeu de résultats retourné par la procédure (dans l’ordre des colonnes).
Les applications doivent lier des colonnes spécifiques au pilote par rapport à la fin du jeu de résultats. Pour plus d’informations, consultez Données retournées par les fonctions de catalogue.
Pour déterminer les longueurs réelles des colonnes PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME et COLUMN_NAME, une application peut appeler SQLGetInfo avec les options SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_PROCEDURE_NAME_LEN et SQL_MAX_COLUMN_NAME_LEN.
Les colonnes suivantes ont été renommées pour ODBC 3.x. Les modifications de nom de colonne n’affectent pas la compatibilité descendante, car les applications sont liées par numéro de colonne.
| Colonne ODBC 2.0 | ODBC 3. colonnex |
|---|---|
| PROCEDURE_QUALIFIER | PROCEDURE_CAT |
| PROCÉDURE _OWNER | PROCEDURE_SCHEM |
| PRÉCISION | COLUMN_SIZE |
| LONGUEUR | BUFFER_LENGTH |
| ÉCAILLE | DECIMAL_DIGITS |
| BASE | NUM_PREC_RADIX |
Les colonnes suivantes ont été ajoutées au jeu de résultats retourné par SQLProcedureColumns pour ODBC 3.x:
COLUMN_DEF
DATETIME_CODE
CHAR_OCTET_LENGTH
ORDINAL_POSITION
IS_NULLABLE
Le tableau suivant répertorie les colonnes du jeu de résultats. Des colonnes supplémentaires au-delà de la colonne 19 (IS_NULLABLE) peuvent être définies par le pilote. Une application doit accéder à des colonnes spécifiques au pilote en comptant à partir de la fin du jeu de résultats plutôt que de spécifier une position ordinale explicite. Pour plus d’informations, consultez Données retournées par les fonctions de catalogue.
| Nom de colonne | Numéro de colonne | Type de données | Commentaires |
|---|---|---|---|
| PROCEDURE_CAT (ODBC 2.0) | 1 | Varchar | Nom du catalogue de procédures ; NULL s’il n’est pas applicable à la source de données. Si un pilote prend en charge les catalogues pour certaines procédures, mais pas pour d’autres, par exemple lorsque le pilote récupère des données à partir de SGBD différents, il retourne une chaîne vide (« ») pour ces procédures qui n’ont pas de catalogues. |
| PROCEDURE_SCHEM (ODBC 2.0) | 2 | Varchar | Nom du schéma de procédure ; NULL s’il n’est pas applicable à la source de données. Si un pilote prend en charge les schémas pour certaines procédures, mais pas pour d’autres, par exemple lorsque le pilote récupère des données à partir de différents SGBD, il retourne une chaîne vide (« ») pour ces procédures qui n’ont pas de schémas. |
| PROCEDURE_NAME (ODBC 2.0) | 3 | Varchar non NULL | Nom de la procédure. Une chaîne vide est retournée pour une procédure qui n’a pas de nom. |
| COLUMN_NAME (ODBC 2.0) | 4 | Varchar non NULL | Nom de la colonne de procédure. Le pilote retourne une chaîne vide pour une colonne de procédure qui n’a pas de nom. |
| COLUMN_TYPE (ODBC 2.0) | 5 | Smallint non NULL | Définit la colonne de procédure en tant que paramètre ou colonne de jeu de résultats : SQL_PARAM_TYPE_UNKNOWN : la colonne de procédure est un paramètre dont le type est inconnu. (ODBC 1.0) SQL_PARAM_INPUT : la colonne de procédure est un paramètre d’entrée. (ODBC 1.0) SQL_PARAM_INPUT_OUTPUT : la colonne de procédure est un paramètre d’entrée/sortie. (ODBC 1.0) SQL_PARAM_OUTPUT : la colonne de procédure est un paramètre de sortie. (ODBC 2.0) SQL_RETURN_VALUE : la colonne de procédure est la valeur de retour de la procédure. (ODBC 2.0) SQL_RESULT_COL : la colonne de procédure est une colonne de jeu de résultats. (ODBC 1.0) |
| DATA_TYPE (ODBC 2.0) | 6 | Smallint non NULL | Type de données SQL. Il peut s’agir d’un type de données SQL ODBC ou d’un type de données SQL spécifique au pilote. Pour les types de données datetime et intervalle, cette colonne retourne les types de données concis (par exemple, SQL_TYPE_TIME ou SQL_INTERVAL_YEAR_TO_MONTH). Pour obtenir la liste des types de données ODBC SQL valides, consultez types de données SQL dans l’annexe D : Types de données. Pour plus d’informations sur les types de données SQL spécifiques au pilote, consultez la documentation du pilote. |
| TYPE_NAME (ODBC 2.0) | 7 | Varchar non NULL | Nom du type de données dépendant de la source de données ; par exemple, « CHAR », « VARCHAR », « MONEY », « LONG VARBINARY » ou « CHAR ( ) FOR BIT DATA ». |
| COLUMN_SIZE (ODBC 2.0) | 8 | Entier | Taille de colonne de la colonne de procédure sur la source de données. NULL est retourné pour les types de données où la taille de colonne n’est pas applicable. Pour plus d’informations sur la précision, consultez taille de colonne, chiffres décimaux, longueur des octets de transfert et taille d’affichage dans l’annexe D : Types de données. |
| BUFFER_LENGTH (ODBC 2.0) | 9 | Entier | Longueur en octets de données transférées sur un SQLGetData ou opération de SQLFetch si SQL_C_DEFAULT est spécifié. Pour les données numériques, cette taille peut être différente de la taille des données stockées sur la source de données. Pour plus d’informations, consultez taille de colonne, chiffres décimaux, longueur des octets de transfert et taille d’affichage, dans l’annexe D : Types de données. |
| DECIMAL_DIGITS (ODBC 2.0) | 10 | Smallint | Chiffres décimaux de la colonne de procédure sur la source de données. NULL est retourné pour les types de données où les chiffres décimaux ne s’appliquent pas. Pour plus d’informations sur les chiffres décimaux, consultez taille de colonne, chiffres décimaux, longueur des octets de transfert et taille d’affichage, dans l’annexe D : Types de données. |
| NUM_PREC_RADIX (ODBC 2.0) | 11 | Smallint | Pour les types de données numériques, 10 ou 2. Si 10, les valeurs dans COLUMN_SIZE et DECIMAL_DIGITS donnent le nombre de chiffres décimaux autorisés pour la colonne. Par exemple, une colonne DECIMAL(12,5) retourne une NUM_PREC_RADIX de 10, une COLUMN_SIZE de 12 et une DECIMAL_DIGITS de 5 ; une colonne FLOAT peut retourner une NUM_PREC_RADIX de 10, une COLUMN_SIZE de 15 et une DECIMAL_DIGITS de NULL. Si 2, les valeurs dans COLUMN_SIZE et DECIMAL_DIGITS donnent le nombre de bits autorisés dans la colonne. Par exemple, une colonne FLOAT peut retourner une NUM_PREC_RADIX de 2, une COLUMN_SIZE de 53 et une DECIMAL_DIGITS de NULL. NULL est retourné pour les types de données où NUM_PREC_RADIX n’est pas applicable. |
| NULLABLE (ODBC 2.0) | 12 | Smallint non NULL | Indique si la colonne de procédure accepte une valeur NULL : SQL_NO_NULLS : la colonne de procédure n’accepte pas les valeurs NULL. SQL_NULLABLE : la colonne de procédure accepte les valeurs NULL. SQL_NULLABLE_UNKNOWN : il n’est pas connu si la colonne de procédure accepte des valeurs NULL. |
| REMARQUES (ODBC 2.0) | 13 | Varchar | Description de la colonne de procédure. |
| COLUMN_DEF (ODBC 3.0) | 14 | Varchar | Valeur par défaut de la colonne. Si NULL a été spécifié comme valeur par défaut, cette colonne est le mot NULL, non placé entre guillemets. Si la valeur par défaut ne peut pas être représentée sans troncation, cette colonne contient TRUNCATED, sans guillemets simples englobants. Si aucune valeur par défaut n’a été spécifiée, cette colonne a la valeur NULL. La valeur de COLUMN_DEF peut être utilisée pour générer une nouvelle définition de colonne, sauf lorsqu’elle contient la valeur TRUNCATED. |
| SQL_DATA_TYPE (ODBC 3.0) | 15 | Smallint non NULL | Valeur du type de données SQL tel qu’il apparaît dans le champ SQL_DESC_TYPE du descripteur. Cette colonne est identique à la colonne DATA_TYPE, à l’exception des types de données datetime et intervalle. Pour les types de données datetime et intervalle, le champ SQL_DATA_TYPE dans le jeu de résultats retourne SQL_INTERVAL ou SQL_DATETIME, et le champ SQL_DATETIME_SUB retourne le sous-code pour le type de données date/heure spécifique. (Consultez l’annexe D : Types de données.) |
| SQL_DATETIME_SUB (ODBC 3.0) | 16 | Smallint | Code de sous-type pour les types de données datetime et intervalle. Pour d’autres types de données, cette colonne retourne une valeur NULL. |
| CHAR_OCTET_LENGTH (ODBC 3.0) | 17 | Entier | Longueur maximale en octets d’une colonne de type de données caractère ou binaire. Pour tous les autres types de données, cette colonne retourne une valeur NULL. |
| ORDINAL_POSITION (ODBC 3.0) | 18 | Entier non NULL | Pour les paramètres d’entrée et de sortie, la position ordinale du paramètre dans la définition de procédure (en augmentant l’ordre des paramètres, à partir de 1). Pour une valeur de retour (le cas échéant), 0 est retourné. Pour les colonnes du jeu de résultats, la position ordinale de la colonne dans le jeu de résultats, la première colonne du jeu de résultats étant le numéro 1. S’il existe plusieurs jeux de résultats, les positions ordinales de colonne sont retournées de manière spécifique au pilote. |
| IS_NULLABLE (ODBC 3.0) | 19 | Varchar | « NON » si la colonne n’inclut pas les VALEURS NULL. « OUI » si la colonne peut inclure des VALEURS NULL. Cette colonne retourne une chaîne de longueur nulle si la valeur Nullability est inconnue. Les règles ISO sont suivies pour déterminer la nullabilité. Un SGBD conforme à SQL ISO ne peut pas retourner une chaîne vide. La valeur retournée pour cette colonne est différente de la valeur retournée pour la colonne NULLABLE. (Consultez la description de la colonne NULLABLE.) |
Exemple de code
Consultez appels de procédure.
Fonctions associées
| Pour plus d’informations sur | Voir |
|---|---|
| Liaison d’une mémoire tampon à une colonne dans un jeu de résultats | fonction SQLBindCol |
| Annulation du traitement des instructions | fonction SQLCancel |
| Extraction d’une seule ligne ou d’un bloc de données dans une direction vers l’avant uniquement | fonction SQLFetch |
| Extraction d’un bloc de données ou défilement d’un jeu de résultats | fonction SQLFetchScroll |
| Renvoi d’une liste de procédures dans une source de données | fonction SQLProcedures |
Voir aussi
informations de référence sur l’API ODBC
fichiers d’en-tête ODBC