WTSLogoffSession, fonction (wtsapi32.h)
Déconnecte une session des services Bureau à distance spécifiée.
Syntaxe
BOOL WTSLogoffSession(
[in] HANDLE hServer,
[in] DWORD SessionId,
[in] BOOL bWait
);
Paramètres
[in] hServer
Handle pour un serveur hôte de session Bureau à distance. Spécifiez un handle ouvert par la fonction WTSOpenServer ou WTSOpenServerEx , ou spécifiez WTS_CURRENT_SERVER_HANDLE pour indiquer le serveur hôte de session Bureau à distance sur lequel votre application s’exécute.
[in] SessionId
Identificateur de session des services Bureau à distance. Pour indiquer la session active, spécifiez WTS_CURRENT_SESSION. Vous pouvez utiliser la fonction WTSEnumerateSessions pour récupérer les identificateurs de toutes les sessions sur un serveur hôte de session Bureau à distance spécifié.
Pour pouvoir vous déconnecter de la session d’un autre utilisateur, vous devez disposer de l’autorisation Réinitialiser. Pour plus d’informations, consultez Autorisations des services Bureau à distance. Pour modifier les autorisations sur une session, utilisez l’outil d’administration Configuration des services Bureau à distance.
Pour déconnecter les sessions en cours d’exécution sur une machine virtuelle hébergée sur un serveur hôte de virtualisation des services Bureau à distance, vous devez être membre du groupe Administrateurs sur le serveur hôte de virtualisation des services Bureau à distance.
[in] bWait
Indique si l’opération est synchrone.
Si bWait a la valeur TRUE, la fonction retourne une fois la session déconnectée.
Si bWait a la valeur FALSE, la fonction retourne immédiatement. Pour vérifier que la session a été déconnectée, spécifiez l’identificateur de session dans un appel à la fonction WTSQuerySessionInformation . WTSQuerySessionInformation retourne zéro si la session est déconnectée.
Valeur retournée
Si la fonction réussit, la valeur de retour est une valeur différente de zéro.
Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows Vista |
| Serveur minimal pris en charge | Windows Server 2008 |
| Plateforme cible | Windows |
| En-tête | wtsapi32.h |
| Bibliothèque | Wtsapi32.lib |
| DLL | Wtsapi32.dll |
| Ensemble d’API | ext-ms-win-session-wtsapi32-l1-1-0 (introduit dans Windows 8) |