Structure JET_RETRIEVECOLUMN

S’applique à : Windows | Windows Server

Structure JET_RETRIEVECOLUMN

La structure JET_RETRIEVECOLUMN contient des paramètres d’entrée et de sortie pour JetRetrieveColumns. Les champs de la structure décrivent la valeur de colonne à récupérer, comment la récupérer et où enregistrer les résultats.

    typedef struct {
      JET_COLUMNID columnid;
      void* pvData;
      unsigned long cbData;
      unsigned long cbActual;
      JET_GRBIT grbit;
      unsigned long ibLongValue;
      unsigned long itagSequence;
      JET_COLUMNID columnidNextTagged;
      JET_ERR err;
    } JET_RETRIEVECOLUMN;

Membres

Columnid

Identificateur de colonne pour la colonne à récupérer.

pvData

Pointeur permettant de commencer à stocker les données récupérées à partir de la valeur de colonne.

cbData

Taille de l’allocation commençant à pvData, en octets. L’opération de récupération de colonne ne stocke pas plus de données dans pvData que cbData.

cbActual

Taille, en octets, des données récupérées par une opération de récupération de colonne.

grbit

Groupe de bits qui contiennent les options de récupération de colonne, qui incluent zéro ou plusieurs des valeurs suivantes.

Valeur	Signification
JET_bitRetrieveCopy	Récupère la valeur modifiée au lieu de la valeur d’origine. Si la valeur n’a pas été modifiée, la valeur d’origine est récupérée. De cette façon, une valeur qui n’a pas encore été insérée ou mise à jour peut être récupérée lorsqu’un enregistrement est inséré ou mis à jour.
JET_bitRetrieveFromIndex	Récupère les valeurs de colonne de l’index sans accéder à l’enregistrement, si possible. De cette façon, le chargement inutile des enregistrements peut être évité lorsque les données nécessaires sont disponibles à partir des entrées d’index elles-mêmes. Dans les cas où la valeur de colonne d’origine ne peut pas être récupérée à partir de l’index, en raison de transformations irréversibles ou de troncation des données, l’enregistrement est accessible et les données récupérées normalement. Il s’agit d’une option de performances qui ne doit être spécifiée que lorsqu’il est probable que la valeur de colonne puisse être récupérée à partir de l’index. Cette option ne doit pas être spécifiée si l’index actuel est l’index cluster, car les entrées d’index pour l’index cluster ou principal sont les enregistrements eux-mêmes. Ce bit ne peut pas être défini si JET_bitRetrieveFromPrimaryBookmark est également défini.
JET_bitRetrieveFromPrimaryBookmark	Récupère les valeurs de colonne du signet d’index et peut différer de la valeur d’index lorsqu’une colonne apparaît à la fois dans l’index principal et dans l’index actuel. Cette option ne doit pas être spécifiée si l’index actuel est l’index cluster ou principal. Ce bit ne peut pas être défini si JET_bitRetrieveFromIndex est également défini.
JET_bitRetrieveTag	Récupère le numéro de séquence d’une valeur de colonne à valeurs multiples dans pretinfo-itagSequence>. Le champ itagSequence est souvent utilisé comme entrée pour récupérer des valeurs de colonne à valeurs multiples à partir d’un enregistrement. Toutefois, lors de la récupération de valeurs à partir d’un index, il est également possible d’associer l’entrée d’index à un numéro de séquence particulier et de récupérer ce numéro de séquence également. La récupération du numéro de séquence peut être une opération coûteuse et ne doit être effectuée que si nécessaire.
JET_ bitRetrieveNull	Récupère des valeurs NULL de colonne à valeurs multiples. Si cette option n’est pas spécifiée, les valeurs NULL de colonne à valeurs multiples sont automatiquement ignorées.
JET_bitRetrieveIgnoreDefault	Entraîne le retour d’une valeur NULL lorsque le numéro de séquence demandé est 1 et qu’il n’existe aucune valeur définie pour la colonne dans l’enregistrement. Cette option affecte uniquement les colonnes à valeurs multiples.
JET_bitRetrieveLongId	Cet indicateur est destiné à un usage interne uniquement et n’est pas destiné à être utilisé dans votre application.
JET_bitRetrieveLongValueRefCount	Cet indicateur est destiné à un usage interne uniquement et n’est pas destiné à être utilisé dans votre application.

ibLongValue

Décalage vers le premier octet à récupérer à partir d’une colonne de type JET_coltypLongBinary ou JET_coltypLongText.

itagSequence

Numéro de séquence des valeurs contenues dans une colonne à valeurs multiples. itagSequence ici dans le JET_RETRIEVECOLUMN peut être 0. Si l’itagSequence est 0, le nombre d’instances d’une colonne à valeurs multiples est retourné à la place des données de colonne. Une valeur itagSequence de 0 ne peut pas être utilisée dans les appels à JetRetrieveColumn.

columnidNextTagged

Columnid de la colonne étiquetée, à valeurs multiples ou éparse lorsque toutes les colonnes balisées sont récupérées en passant 0 en tant que columnid à JetRetrieveColumn.

err

Codes d’erreur et avertissements retournés par la récupération de la colonne.

Spécifications

Condition requise	Valeur
Client	Nécessite Windows Vista, Windows XP ou Windows 2000 Professionnel.
Serveur	Nécessite Windows Server 2008, Windows Server 2003 ou Windows 2000 Server.
En-tête	Déclaré dans Esent.h.

Voir aussi

JET_COLTYP
JET_COLUMNID
JET_ERR
JET_GRBIT
JET_RETRIEVECOLUMN
JetRetrieveColumn
JetRetrieveColumns