JetGetLS fonction)
S’applique à : Windows | Windows Serveurs
JetGetLS fonction)
la fonction JetGetLS permet à l’application de récupérer le descripteur de contexte appelé Local Stockage associé à un curseur ou à la table associée à ce curseur. Ce descripteur de contexte doit avoir été défini précédemment à l’aide de JetSetLS. JetGetLS peut également être utilisé pour extraire simultanément le descripteur de contexte actuel d’un curseur ou d’une table et réinitialiser ce handle de contexte.
Windows xp : JetGetLS est introduit dans Windows xp.
JET_ERR JET_API JetGetLS(
__in JET_SESID sesid,
__in JET_TABLEID tableid,
__out JET_LS* pls,
__in JET_GRBIT grbit
);
Paramètres
sesid
Session à utiliser pour cet appel.
TableID
Curseur à utiliser pour cet appel.
pls
Mémoire tampon de sortie qui reçoit le handle de contexte actuellement associé au curseur ou à la table.
grbit
Groupe de bits spécifiant zéro ou plusieurs des options suivantes.
Valeur |
Signification |
|---|---|
JET_bitLSCursor |
Indique que le handle de contexte associé au curseur donné doit être récupéré. Si ni JET_bitLSCursor ni JET_bitLSTable n’est spécifié, JET_bitLSCursor est présumé. Cette option ne peut pas être utilisée avec JET_bitLSTable. L’opération échouera avec JET_errInvalidgrbit si cette tentative est effectuée. |
JET_bitLSTable |
Indique que le handle de contexte associé à la table qui contient le curseur donné doit être récupéré. L’utilisation de cette option avec JET_bitLSCursor n’est pas autorisée. L’opération échouera avec JET_errInvalidgrbit si cette tentative est effectuée. |
JET_bitLSReset |
Indique que le handle de contexte pour l’objet choisi doit être réinitialisé à JET_LSNil. La valeur actuelle du handle de contexte est retournée dans la mémoire tampon de sortie. |
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 |
Il n’est pas possible de terminer l’opération, car toute activité sur l’instance associée à la session a été interrompue suite à un appel à JetStopService. |
JET_errInstanceUnavailable |
Il n’est pas possible de terminer 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. cette erreur est renvoyée uniquement par Windows XP et les versions ultérieures. |
JET_errInvalidgrbit |
L’une des options demandées n’est pas valide, utilisée de manière non conforme ou non implémentée. Cela peut se produire pour JetGetLS quand les JET_bitLSCursor et les JET_bitLSTable sont définis. |
JET_errLSNotSet |
Impossible de retourner le descripteur de contexte, car aucun descripteur de contexte n’est actuellement associé à l’objet demandé. Remarque Cette erreur n’est pas renvoyée si JET_bitLSReset est spécifié mais qu’aucun handle de contexte n’a été associé à l’objet demandé. |
JET_errNotInitialized |
Impossible de terminer l’opération, car l’instance associée à la session n’a pas encore été initialisée. |
JET_errRestoreInProgress |
Il n’est pas possible de terminer l’opération, car une opération de restauration est en cours sur l’instance associée à la session. |
JET_errTermInProgress |
Il n’est pas possible de terminer l’opération, car l’instance associée à la session est en cours d’arrêt. |
En cas de réussite, le handle de contexte a été récupéré à partir de l’objet demandé. Si JET_bitLSReset a été spécifié, ce handle de contexte a également été correctement supprimé de l’objet. Aucune modification de l’état de la base de données ne se produit.
En cas d’échec, aucune modification de l’état de l’objet demandé n’est survenue. Aucune modification de l’état de la base de données ne se produit.
Configuration requise
| | |
Client
|requiert Windows Vista ou Windows XP.
| |Serveur
|requiert Windows server 2008 ou Windows server 2003.
| |En-tête
|Déclaré dans esent. h.
| |Bibliothèque
|Utilisez ESENT. lib.
| |DLL
|Requiert ESENT.dll.
|