Fonction JetSetLS

S’applique à : Windows | Windows Serveurs

Fonction JetSetLS

la fonction JetSetLS permet à l’application d’associer un handle de contexte appelé Stockage Local avec un curseur ou la table associée à ce curseur. Ce descripteur de contexte peut être utilisé par l’application pour stocker les données auxiliaires associées à un curseur ou une table. L’application est notifiée ultérieurement à l’aide d’un rappel d’exécution lorsque le handle de contexte doit être libéré. Cela permet d’associer l’État alloué dynamiquement à un curseur ou une table.

**Windows xp :**JetSetLS est introduit dans Windows xp.

    JET_ERR JET_API JetSetLS(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          JET_LS ls,
      __in          JET_GRBIT grbit
    );

Paramètres

sesid

Session à utiliser pour cet appel.

TableID

Curseur à utiliser pour cet appel.

ls

Handle de contexte à associer au curseur ou à la table.

Lorsque JET_bitLSReset est spécifié, la valeur réelle de ce paramètre est ignorée et JET_LSNil est utilisé.

grbit

Groupe de bits qui contiennent les options à utiliser pour cet appel, qui incluent zéro ou plusieurs des éléments suivants.

Valeur

Signification

JET_bitLSCursor

Cette option indique que le handle de contexte doit être associé au curseur donné.

Si ni JET_bitLSCursor ni JET_bitLSTable n’est spécifié, JET_bitLSCursor est présumé.

L’utilisation de cette option avec JET_bitLSTable n’est pas autorisée. L’opération échouera avec JET_errInvalidgrbit si cette tentative est effectuée.

JET_bitLSReset

Cette option indique que le handle de contexte spécifié doit être ignoré et que le handle de contexte pour l’objet choisi doit être réinitialisé à JET_LSNil.

Il est important de noter que cette action n’entraîne pas de rappel pour nettoyer la valeur précédente du handle de contexte pour l’objet choisi. Le nettoyage approprié du descripteur de contexte précédent peut être effectué à l’aide de JetGetLS avec JET_bitLSReset. Pour plus d’informations, consultez JetGetLS .

JET_bitLSTable

Cette option indique que le descripteur de contexte doit être associé à la table associée au curseur donné.

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.

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_errInvalidgrbit

L’une des options demandées n’est pas valide, a été utilisée de manière incorrecte ou n’a pas été implémentée. Cela peut se produire pour JetSetLS quand JET_bitLSCursor et JET_bitLSTable sont spécifiés.

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_errLSAlreadySet

Le handle de contexte indiqué n’a pas pu être associé à l’objet demandé, car un handle de contexte lui est déjà associé.

JET_errLSCallbackNotSpecified

Le handle de contexte indiqué n’a pas pu être associé à l’objet demandé, car le rappel d’exécution n’a pas été configuré pour l’instance associée à la session.

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 donné a été associé avec succès à l’objet demandé. 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.

Remarques

le Stockage Local pour un curseur ou une table doit être affiché en tant que cache volatile. L’application doit d’abord essayer de récupérer le handle de contexte à l’aide de JetGetLS. Si la valeur n’est pas définie (JET_LSNil), l’application doit créer un nouveau contexte et la charger dans le cache à l’aide de JetSetLS. L’application peut purger le cache à l’aide d’un appel à JetGetLS avec JET_bitLSReset. Si le moteur de base de données vide le cache, un rappel d’exécution sera généré pour permettre à l’application de nettoyer ce contexte. Le type de rappel sera JET_cbtypFreeCursorLS pour un handle de contexte associé à un curseur et JET_cbtypFreeTableLS pour un handle de contexte associé à une table. Dans les deux cas, le handle de contexte est passé en tant que pvArg1. Pour plus d’informations, consultez JET_CALLBACK .

le rappel d’exécution doit être configuré correctement pour l’instance associée à la session donnée avant de pouvoir utiliser des Stockage locales. Ce rappel peut être défini à l’aide de JetSetSystemParameter avec JET_paramRuntimeCallback. Pour plus d’informations, consultez JetSetSystemParameter et JET_paramRuntimeCallback dans paramètres système.

Configuration requise

Condition requise Valeur

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.

Voir aussi

JET_CALLBACK
JET_ERR
JET_GRBIT
JET_LS
JET_SESID
JET_TABLEID
JetGetLS
JetSetSystemParameter
Paramètres système