Fonction SQLGetDescField

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

Résumé
SQLGetDescField retourne le paramètre actuel ou la valeur d’un champ unique d’un enregistrement de descripteur.

Syntaxe

  
SQLRETURN SQLGetDescField(  
     SQLHDESC        DescriptorHandle,  
     SQLSMALLINT     RecNumber,  
     SQLSMALLINT     FieldIdentifier,  
     SQLPOINTER      ValuePtr,  
     SQLINTEGER      BufferLength,  
     SQLINTEGER *    StringLengthPtr);  

Arguments

DescriptorHandle
[Entrée] Handle de descripteur.

RecNumber
[Entrée] Indique l’enregistrement de descripteur à partir duquel l’application recherche des informations. Les enregistrements de descripteur sont numérotés à partir de 0, le numéro d’enregistrement 0 étant l’enregistrement de signet. Si l’argument FieldIdentifier indique un champ d’en-tête, RecNumber est ignoré. Si RecNumber est inférieur ou égal à SQL_DESC_COUNT mais que la ligne ne contient pas de données pour une colonne ou un paramètre, un appel à SQLGetDescField renvoie les valeurs par défaut des champs. (Pour plus d’informations, consultez « Initialisation des champs de descripteur » dans SQLSetDescField.)

FieldIdentifier
[Entrée] Indique le champ du descripteur dont la valeur doit être retournée. Pour plus d’informations, consultez la section « Argument FieldIdentifier » dans SQLSetDescField.

ValuePtr
[Sortie] Pointeur vers une mémoire tampon dans laquelle retourner les informations de descripteur. Le type de données dépend de la valeur de FieldIdentifier.

Si ValuePtr est de type entier, les applications doivent utiliser une mémoire tampon de SQLULEN et initialiser la valeur sur 0 avant d’appeler cette fonction, car certains pilotes peuvent écrire uniquement les 32 bits inférieurs ou 16 bits d’une mémoire tampon et laisser le bit d’ordre supérieur inchangé.

Si ValuePtr a la valeur NULL, StringLengthPtr retourne toujours le nombre total d’octets (à l’exclusion du caractère d’arrêt Null pour les données de caractères) pouvant être retournés dans la mémoire tampon vers laquelle valuePtr pointe.

BufferLength
[Entrée] Si FieldIdentifier est un champ défini par ODBC et que ValuePtr pointe vers une chaîne de caractères ou une mémoire tampon binaire, cet argument doit être la longueur de *ValuePtr. Si FieldIdentifier est un champ défini par ODBC et *ValuePtr est un entier, BufferLength est ignoré. Si la valeur dans *ValuePtr est d’un type de données Unicode (lors de l’appel de SQLGetDescFieldW), l’argument BufferLength doit être un nombre pair.

Si FieldIdentifier est un champ défini par le pilote, l’application indique la nature du champ au Gestionnaire de pilotes en définissant l’argument BufferLength . BufferLength peut avoir les valeurs suivantes :

• Si *ValuePtr est un pointeur vers une chaîne de caractères, BufferLength est la longueur de la chaîne ou du SQL_NTS.

• Si *ValuePtr est un pointeur vers une mémoire tampon binaire, l’application place le résultat de la macro SQL_LEN_BINARY_ATTR(length) dans BufferLength. Cela place une valeur négative dans BufferLength.

• Si *ValuePtr est un pointeur vers une valeur autre qu’une chaîne de caractères ou une chaîne binaire, BufferLength doit avoir la valeur SQL_IS_POINTER.

• Si *ValuePtr contient un type de données de longueur fixe, BufferLength est SQL_IS_INTEGER, SQL_IS_UINTEGER, SQL_IS_SMALLINT ou SQL_IS_USMALLINT, le cas échéant.

StringLengthPtr
[Sortie] Pointeur vers la mémoire tampon dans laquelle retourner le nombre total d’octets (à l’exclusion du nombre d’octets requis pour le caractère d’arrêt null) pouvant être retournés dans *ValuePtr.

Retours

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, SQL_NO_DATA ou SQL_INVALID_HANDLE.

SQL_NO_DATA est retourné si RecNumber est supérieur au nombre actuel d’enregistrements de descripteur.

SQL_NO_DATA est retourné si DescriptorHandle est un handle IRD et que l’instruction est à l’état préparé ou exécuté, mais qu’aucun curseur ouvert n’y était associé.

Diagnostics

Lorsque SQLGetDescField 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 handled’instructionHandle. Le tableau suivant répertorie les valeurs SQLSTATE couramment retournées par SQLGetDescField 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.

Commentaires

Une application peut appeler SQLGetDescField pour retourner la valeur d’un champ unique d’un enregistrement de descripteur. Un appel à SQLGetDescField peut retourner le paramètre de n’importe quel champ dans n’importe quel type de descripteur, y compris les champs d’en-tête, les champs d’enregistrement et les champs de signet. Une application peut obtenir les paramètres de plusieurs champs dans les descripteurs identiques ou différents, dans un ordre arbitraire, en effectuant des appels répétés à SQLGetDescField. SQLGetDescField peut également être appelé pour retourner des champs de descripteur définis par le pilote.

Pour des raisons de performances, une application ne doit pas appeler SQLGetDescField pour un IRD avant d’exécuter une instruction.

Les paramètres de plusieurs champs qui décrivent le nom, le type de données et le stockage des données de colonne ou de paramètre peuvent également être récupérés en un seul appel à SQLGetDescRec. SQLGetStmtAttr peut être appelé pour retourner le paramètre d’un champ unique dans l’en-tête de descripteur qui est également un attribut d’instruction. SQLColAttribute, SQLDescribeCol et SQLDescribeParam retournent des champs d’enregistrement ou de signet.

Lorsqu’une application appelle SQLGetDescField pour récupérer la valeur d’un champ qui n’est pas défini pour un type de descripteur particulier, la fonction retourne SQL_SUCCESS mais la valeur retournée pour le champ n’est pas définie. Par exemple, l’appel de SQLGetDescField pour le champ SQL_DESC_NAME ou SQL_DESC_NULLABLE d’un champ APD ou ARD renvoie SQL_SUCCESS mais une valeur non définie pour le champ.

Lorsqu’une application appelle SQLGetDescField pour récupérer la valeur d’un champ défini pour un type de descripteur particulier, mais qui n’a pas de valeur par défaut et qui n’a pas encore été défini, la fonction retourne SQL_SUCCESS mais la valeur retournée pour le champ n’est pas définie. Pour plus d’informations sur l’initialisation des champs de descripteur et leur description, consultez « Initialisation des champs de descripteur » dans SQLSetDescField. Pour plus d’informations sur les descripteurs, consultez Descripteurs.

Fonctions connexes

Voir aussi

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