Fonction JetSetSessionParameter

S’applique à : Windows | Windows Server

La fonction JetSetSessionParameter configure le moteur de base de données.

JET_ERR JET_API JetSetSessionParameter (
  __in_opt      JET_SESID sesid,
  __in          unsigned long sesparamid,
  __in_read_bytes_opt_(cbParam)  void* pvParam,
  __in          unsigned long cbParam
);

Paramètres

sesid

Spécifie la session à utiliser pour cet appel.

Lorsqu’il est spécifié, le instance spécifié est ignoré et le instance associé à la session est utilisé.

sesparamid

ID du paramètre de session à définir.

pvParam

Données à définir dans ce paramètre de session.

cbParam

Taille des données fournies.

Valeur retournée

Cette fonction retourne le type de données JET_ERR avec l’un des codes de retour répertoriés dans le tableau suivant. Pour plus d’informations sur les erreurs possibles du moteur de stockage extensible (ESE), 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_errAlreadyInitialized	Le instance a été initialisé à l’aide d’un appel à la fonction JetInit et cette opération ne peut pas être effectuée en conséquence. Cela peut se produire lorsqu’une tentative de configuration d’un paramètre système est effectuée après qu’une modification de la valeur du paramètre ne peut plus affecter l’état du moteur de base de données.
JET_errClientRequestToStopJetService	Il n’est pas possible d’effectuer l’opération, car toute l’activité sur le instance associée à la session a cessé à la suite d’un appel à la fonction JetStopService.
JET_errIndexTuplesInvalidLimits	Les paramètres d’index tuple spécifiés n’étaient pas valides. Cette erreur est retournée uniquement lorsque le paramètre JET_paramIndexTuplesLengthMin, JET_paramIndexTuplesLengthMax ou JET_paramIndexTuplesToIndexMax est défini sur une valeur non valide. Pour plus d’informations sur ces paramètres, consultez Paramètres d’index.
JET_errInitInProgress	Il n’est pas possible d’effectuer l’opération, car le instance associé à la session est en cours d’initialisation.
JET_errInstanceUnavailable	Il n’est pas possible d’effectuer l’opération, car le instance associé à la session a rencontré une erreur irrécupérable qui exige que l’accès à toutes les données soit révoqué pour protéger l’intégrité de ces données.
JET_errInvalidParameter	L’un des paramètres fournis contenait une valeur inattendue ou contenait une valeur qui n’était pas logique lorsqu’elle était combinée à la valeur d’un autre paramètre. Cela peut se produire lorsque les événements suivants se produisent : L’ID de paramètre système spécifié n’est pas valide ou n’est pas pris en charge. Une tentative a été effectuée pour définir un paramètre système à valeur de chaîne avec une chaîne dont la longueur se trouvait en dehors de la plage légale pour le paramètre. Une tentative a été effectuée pour définir un paramètre système à valeur de chaîne avec un chemin d’accès de fichier où la longueur de sa représentation de chemin d’accès absolu se trouvait en dehors de la plage légale pour ce paramètre. Une tentative a été effectuée pour définir un paramètre système à valeur entière avec un entier qui se trouvait en dehors de la plage légale du paramètre. Une tentative a été effectuée pour définir JET_paramUnicodeIndexDefault avec un pointeur null JET_UNICODEINDEX , un LCID non valide ou un ensemble d’indicateurs LCMapString non pris en charge. Le paramètre système spécifié ne peut pas être défini, car il est en lecture seule. Une tentative de définition d’un paramètre système a été effectuée après l’appel de la fonction JetInit, le moteur de base de données est en mode instance unique et aucune session n’a été spécifiée. Le paramètre système spécifié est global uniquement et une tentative de définition d’une valeur spécifique à instance pour ce paramètre système a été effectuée. Le paramètre système spécifié est par instance uniquement et une tentative de définition de la valeur globale de ce paramètre système a été effectuée.
JET_errInvalidPath	Le chemin du système de fichiers spécifié n’était pas valide. Cette erreur peut être retournée par JetSetSessionParameter uniquement lors de la définition de paramètres système qui représentent les chemins d’accès du système de fichiers. Par exemple, le paramètre JET_paramSystemPath peut renvoyer cette erreur. Pour plus d’informations sur ce paramètre, consultez Paramètres du journal des transactions.
JET_errNotInitialized	Il n’est pas possible d’effectuer l’opération, car le instance associé à la session n’a pas encore été initialisé.
JET_errRestoreInProgress	Il n’est pas possible d’effectuer l’opération, car une opération de restauration est en cours sur le instance associé à la session.
JET_errTermInProgress	Il n’est pas possible d’effectuer l’opération, car le instance associé à la session est en cours d’arrêt.
JET_errInvalidSesid	Le handle de session n’est pas valide ou fait référence à une session fermée. Cette erreur n’est pas retournée dans toutes les circonstances. Les handles sont validés uniquement sur la base du meilleur effort.
JET_errInvalidInstance	Le handle instance n’est pas valide ou fait référence à un instance qui a été arrêté. Cette erreur n’est pas retournée dans toutes les circonstances. Les handles sont validés uniquement sur la base du meilleur effort.

En cas de réussite, le paramètre système est défini sur la valeur fournie.

En cas d’échec, la valeur du paramètre système reste inchangée.

Spécifications

Condition requise	Valeur
Client	Nécessite Windows 8.
Serveur	Nécessite Windows Server 2012.
En-tête	Déclaré dans Esent.h.
Bibliothèque	Utilisez ESENT.lib.
DLL	Nécessite ESENT.dll.

Voir aussi

JET_API_PTR
JET_ERR
JET_INSTANCE
JET_SESID
JetCreateInstance
JetGetSystemParameter
JetInit
Paramètres système