Fonction LocalDBStopInstance

Article
07/04/2024

S’applique à : SQL Server

Arrête l'exécution de l'instance SQL Server Express LocalDB spécifiée.

Fichier d’en-tête : msoledbsql.h

Syntaxe

HRESULT LocalDBStopInstance(  
           PCWSTR pInstanceName,  
           DWORD dwFlags,   
           ULONG ulTimeout   
);

Paramètres

pInstanceName
[Entrée] Nom de l'instance de LocalDB à arrêter.

dwFlags
[Entrée] Valeur d'indicateur ou combinaison de valeurs d'indicateur indiquant la façon d'arrêter l'instance.

Indicateurs disponibles :

LOCALDB_SHUTDOWN_KILL_PROCESS
Arrêter immédiatement à l'aide de la commande du système d'exploitation Terminer le processus.

LOCALDB_SHUTDOWN_WITH_NOWAIT
Arrêter à l'aide de l'option de commande Transact-SQL WITH NOWAIT.

Si aucun des indicateurs n'est défini, l'instance de LocalDB sera arrêtée à l'aide de la commande Transact-SQL SHUTDOWN. Si les deux indicateurs sont définis, l'indicateur LOCALDB_SHUTDOWN_KILL_PROCESS est prioritaire.

ulTimeout
[Entrée] Durée d'attente en secondes pour l'exécution de cette opération. Si cette valeur est 0, cette fonction retournera immédiatement sans attendre l'arrêt de l'instance de LocalDB.

Retours

S_OK
La fonction a réussi.

LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB n'est pas installé sur l'ordinateur.

LOCALDB_ERROR_INVALID_PARAMETER
Un ou plusieurs paramètres d'entrée spécifiés ne sont pas valides.

LOCALDB_ERROR_INVALID_INSTANCE_NAME
Le nom d'instance spécifié n'est pas valide.

LOCALDB_ERROR_UNKNOWN_INSTANCE
L'instance n'existe pas.

LOCALDB_ERROR_WAIT_TIMEOUT
Un dépassement de délai s'est produit lors de la tentative d'acquisition des verrous de synchronisation.

LOCALDB_ERROR_INSTANCE_STOP_FAILED
L'opération d'arrêt ne s'est pas terminée dans le délai imparti.

LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG
Le chemin d'accès où l'instance doit être stockée est plus long que MAX_PATH.

LOCALDB_ERROR_CANNOT_GET_USER_PROFILE_FOLDER
Impossible de récupérer un dossier du profil utilisateur.

LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_FOLDER
Un dossier d'instance n'est pas accessible.

LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY
Un Registre d'instance n'est pas accessible.

LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT
Une configuration d'instance est endommagée.

LOCALDB_ERROR_CALLER_IS_NOT_OWNER
L'appelant de l'API n'est pas le propriétaire de l'instance de LocalDB.

LOCALDB_ERROR_INTERNAL_ERROR
Une erreur inattendue s’est produite. Pour plus d'informations, consultez le journal des événements.

Notes

Pour un exemple de code qui utilise l'API LocalDB, consultez SQL Server Express LocalDB Reference.

Voir aussi

En-tête et informations de version de la base de données locale SQL Server Express

Partager via