JetGotoBookmark fonction)

S’applique à : Windows | Windows Serveurs

JetGotoBookmark fonction)

La fonction JetGotoBookmark positionne un curseur sur une entrée d’index pour l’enregistrement associé au signet spécifié. Le signet peut être utilisé avec n’importe quel index défini sur une table. Le signet d’un enregistrement peut être récupéré à l’aide de JetGetBookmark.

    JET_ERR JET_API JetGotoBookmark(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          void* pvBookmark,
      __in          unsigned long cbBookmark
    );

Paramètres

sesid

Session à utiliser pour cet appel.

TableID

Curseur à utiliser pour cet appel.

pvBookmark

Mémoire tampon qui contient le signet à utiliser pour positionner le curseur.

cbBookmark

Taille du signet dans la mémoire tampon.

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_errClientRequestToStopJetService

Impossible d’effectuer l’opération, car toute activité sur l’instance associée à la session a été interrompue suite à un appel à JetStopService.

JET_errInstanceUnavailable

Impossible d’effectuer l’opération, car l’instance associée à la session a rencontré une erreur irrécupérable qui requiert que l’accès à toutes les données soit révoqué pour protéger l’intégrité de ces données.

Windows XP : cette valeur de retour a été introduite dans Windows XP.

JET_errInvalidBookmark

Le signet fourni n’est pas valide. Cela peut être dû au fait que la taille du signet est égale à zéro ou que le pointeur de la mémoire tampon du signet a la valeur null.

JET_errNoCurrentRecord

Le curseur se trouve sur un index secondaire et aucune entrée d’index n’a été trouvée pour l’enregistrement associé au signet.

JET_errNotInitialized

Impossible de terminer l’opération, car l’instance associée à la session n’a pas encore été initialisée.

JET_errRecordDeleted

L’enregistrement associé au signet est introuvable.

JET_errRestoreInProgress

Impossible de terminer l’opération, car une opération de restauration est en cours sur l’instance associée à la session.

JET_errSessionSharingViolation

La même session ne peut pas être utilisée simultanément pour plusieurs threads.

Windows XP : cette valeur de retour a été introduite dans Windows XP.

JET_errTermInProgress

L’opération ne peut pas se terminer car l’instance associée à la session est en cours d’arrêt.

Si cette fonction est réussie, le curseur est positionné sur une entrée d’index pour l’enregistrement associé au signet spécifié. Si un enregistrement a été préparé pour la mise à jour, cette mise à jour sera annulée. Si une plage d’index est en vigueur, cette plage d’index sera annulée. Si une clé de recherche a été construite pour le curseur, cette clé de recherche sera supprimée. Aucune modification de l’état de la base de données ne se produit.

Si cette fonction échoue, la position du curseur reste inchangée. Si un enregistrement a été préparé pour la mise à jour, cette mise à jour sera annulée. Si une plage d’index est en vigueur, cette plage d’index sera annulée. Si une clé de recherche a été construite pour le curseur, cette clé de recherche sera supprimée. Aucune modification de l’état de la base de données ne se produit.

Remarques

Il existe deux façons d’utiliser un signet pour positionner un curseur sur un index. La première consiste à utiliser le signet pour positionner directement sur l’enregistrement. Cela se produit lorsque l’index actuel du curseur est l’index primaire. Cette technique fonctionne, car un signet ESENT est le même que la clé primaire de l’enregistrement associé.

La deuxième façon d’utiliser un signet est de le positionner sur une entrée dans un index secondaire qui correspond à l’enregistrement associé à ce signet. Pendant ce processus, le moteur recherche l’enregistrement réel à l’aide du signet sur l’index primaire. Il utilise ensuite les données d’enregistrement et la définition d’index secondaire pour calculer une clé dans l’index secondaire qui pointe vers l’enregistrement. Il positionne ensuite le curseur sur l’entrée d’index pour cette clé. Si le curseur se trouve actuellement sur un index secondaire sur une ou plusieurs colonnes clés à valeurs multiples, le curseur est positionné sur l’entrée d’index correspondant à la première valeur multiple de chacune de ces colonnes clés.

Configuration requise

| | |

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.

|

Voir aussi

JET_ERR
JET_SESID
JET_TABLEID
JetGetBookmark