Fonction JetGetColumnInfo

S’applique à : Windows | Windows Serveurs

Fonction JetGetColumnInfo

La fonction JetGetColumnInfo récupère des informations sur une colonne.

    JET_ERR JET_API JetGetColumnInfo(
      __in          JET_SESID sesid,
      __in          JET_DBID dbid,
      __in          const tchar* szTableName,
      __in          const tchar* szColumnName,
      __out         void* pvResult,
      __in          unsigned long cbMax,
      __in          unsigned long InfoLevel
    );

Paramètres

sesid

Contexte de la session de base de données à utiliser pour l’appel d’API.

dbid

Identifie, avec szTableName, la table qui contient la colonne à partir de laquelle les informations sont récupérées.

szTableName

Identifie, avec dbid, la table qui contient la colonne à partir de laquelle les informations sont récupérées.

szColumnName

Nom de la colonne pour laquelle les informations sont extraites.

pvResult

Pointeur vers une mémoire tampon qui recevra les informations. Le type de la mémoire tampon dépend de InfoLevel. L’appelant doit être configuré pour aligner la mémoire tampon de manière appropriée.

cbMax

Taille, en octets, de la mémoire tampon passée dans pvResult.

InfoLevel

Type d’informations à récupérer pour la colonne spécifiée par szColumnName. Le format des données stockées dans pvResult dépend de ce paramètre. Pour obtenir le schéma de la table temporaire, consultez JET_COLUMNLIST.

Ces InfoLevels sont différenciées par :

  • JET_ColInfoListSortColumnid triera la table temporaire par ColumnID.

  • JET_ColInfoListCompact compacte la sortie. Pour plus d’informations sur la sortie compacte, consultez JET_COLUMNLIST.

Les options suivantes peuvent être utilisées avec ce paramètre.

Valeur

Signification

JET_ColInfo

JET_ColInfo et JET_ColInfoByColid récupérer les mêmes informations. pvResult est interprété comme un JET_COLUMNDEFet les champs de la structure JET_COLUMNDEF sont remplis de manière appropriée.

JET_ColInfoBase

pvResult est interprété comme une structure de JET_COLUMNBASE . Cela est similaire à une structure de JET_COLUMNDEF . Si cette fonction est réussie, la structure est remplie avec les valeurs appropriées. Si cette fonction échoue, la structure contient des données non définies.

JET_ColInfoByColid

Comme JET_ColInfo, pvResult est interprété comme un JET_COLUMNDEF, sauf que ce InfoLevel indique que la colonne demandée (szColumName) n’est pas le nom de la colonne de chaîne, mais un pointeur vers un JET_COLUMNID.

JET_ColInfoList

pvResult est interprété comme une structure de JET_COLUMNLIST . Si cette fonction est réussie, la structure est remplie avec les valeurs appropriées. Une table temporaire est ouverte et identifiée par le membre TableID de la structure JET_COLUMNLIST . La table doit être fermée avec JetCloseTable. Si cette fonction échoue, la structure contient des données non définies.

JET_ColInfoListCompact

Identique à JET_ColInfoList.

JET_ColInfoListSortColumnid

Identique à JET_ColInfoList ; Toutefois, la table résultante est triée par ColumnId, au lieu du nom de colonne.

JET_ColInfoSysTabCursor

JET_ColInfoSysTabCursor est déconseillé et son utilisation retourne JET_errFeatureNotAvailable.

JET_ColInfoBaseByColId

Comme JET_ColInfoBase, pvResult est interprété comme un JET_COLUMNBASE, sauf que ce InfoLevel indique que la colonne demandée (szColumName) n’est pas le nom de la colonne de chaîne, mais un pointeur vers un JET_COLUMNID.

Windows Vista : cette valeur est introduite dans Windows Vista.

JET_ColInfoGrbitNonDerivedColumnsOnly

Retourne uniquement les colonnes non dérivées (si la table est dérivée d’un modèle).

Cette valeur peut être logiquement ou en InfoLevel, lorsque le InfoLevel de base est JET_ColInfoList.

Windows Vista : cette valeur est introduite Windows Vista.

JET_ColInfoGrbitMinimalInfo

Retourne uniquement le nom de colonne et le ColumnID de chaque colonne.

Cette valeur peut être logiquement ou en InfoLevel, lorsque le InfoLevel de base est JET_ColInfoList.

Windows Vista : cette valeur est introduite dans Windows Vista.

JET_ColInfoGrbitSortByColumnid

Trie la liste des colonnes retournées par ColumnId (par défaut, trie la liste par nom de colonne).

Cette valeur peut être logiquement ou en InfoLevel, lorsque le InfoLevel de base est JET_ColInfoList.

Windows Vista : cette valeur est introduite dans Windows Vista.

Valeur renvoyée

Cette fonction retourne le type de données JET_ERR avec l’un des codes de retour suivants. pour plus d’informations sur les erreurs ESE possibles, consultez erreurs du moteur de Stockage Extensible et paramètres de gestion des erreurs.

Code de retour

Description

JET_errSuccess

L’opération s’est terminée avec succès.

JET_errColumnNotFound

La colonne nommée szColumnName est introuvable dans la table.

JET_errFeatureNotAvailable

Un InfoLevel incorrect a été spécifié.

JET_errInvalidName

Cette erreur peut être retournée dans les cas suivants :

  • Un nom incorrect a été donné pour szTableName .

  • Un nom incorrect a été donné pour szColumnName .

JET_errInvalidParameter

Cette erreur peut être retournée dans les cas suivants :

  • Un InfoLevel incorrect a été spécifié.

  • Un SZTABLENAME null a été passé.

  • La mémoire tampon est insuffisante.

Remarques

JetGetTableColumnInfo et JetGetColumnInfo récupèrent les informations sur une colonne. La différence entre les deux est la manière dont la table est identifiée :

  • JetGetTableColumnInfo identifie une table par TableID.

  • JetGetColumnInfo identifie une table par la combinaison dbid et szTableName .

Lorsque vous récupérez des données avec JET_ColInfoList, JET_ColInfoListSortColumnid ou JET_ColInfoListCompact, une table temporaire est ouverte. La table temporaire contient des données et la structure JET_COLUMNLIST contient des informations suffisantes pour parcourir la table temporaire. La table temporaire doit être fermée avec JetCloseTable.

Configuration requise

Condition requise Valeur

Client

requiert Windows Vista, Windows XP ou Windows 2000 Professional.

Serveur

nécessite Windows server 2008, Windows server 2003 ou Windows 2000 server.

En-tête

Déclaré dans esent. h.

Bibliothèque

Utilisez ESENT. lib.

DLL

Requiert ESENT.dll.

Unicode

Implémenté en tant que JetGetColumnInfoW (Unicode) et JetGetColumnInfoA (ANSI).

Voir aussi

Paramètres de gestion des erreurs
erreurs du moteur de Stockage Extensible
JET_COLUMNBASE
JET_COLUMNDEF
JET_COLUMNID
JET_COLUMNLIST
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetCloseTable
JetGetTableColumnInfo