Функция WTSLogoffSession (wtsapi32.h)

Выполняет выход из указанного сеанса служб удаленных рабочих столов.

Синтаксис

BOOL WTSLogoffSession(
  [in] HANDLE hServer,
  [in] DWORD  SessionId,
  [in] BOOL   bWait
);

Параметры

[in] hServer

Дескриптор сервера узла сеансов удаленных рабочих стола. Укажите дескриптор, открытый функцией WTSOpenServer или WTSOpenServerEx , или укажите WTS_CURRENT_SERVER_HANDLE , чтобы указать сервер узла сеансов удаленных рабочих столов, на котором выполняется приложение.

[in] SessionId

Идентификатор сеанса Служб удаленных рабочих столов. Чтобы указать текущий сеанс, укажите WTS_CURRENT_SESSION. Функцию WTSEnumerateSessions можно использовать для получения идентификаторов всех сеансов на указанном сервере узла сеансов удаленных рабочих столов.

Чтобы иметь возможность выйти из сеанса другого пользователя, необходимо иметь разрешение Сброс. Дополнительные сведения см. в разделе Разрешения служб удаленных рабочих столов. Чтобы изменить разрешения для сеанса, используйте средство администрирования Конфигурации служб удаленных рабочих столов.

Чтобы выйти из сеансов, выполняемых на виртуальной машине, размещенной на сервере узла виртуализации удаленных рабочих стола, необходимо быть членом группы администраторов на сервере узла виртуализации удаленных рабочих стола.

[in] bWait

Указывает, является ли операция синхронной.

Если bWait имеет значение TRUE, функция возвращает значение при выходе сеанса из системы.

Если bWait имеет значение FALSE, функция возвращается немедленно. Чтобы убедиться, что сеанс был выключен, укажите идентификатор сеанса в вызове функции WTSQuerySessionInformation . WTSQuerySessionInformation возвращает ноль, если сеанс выключается.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет ненулевым.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Целевая платформа	Windows
Header	wtsapi32.h
Библиотека	Wtsapi32.lib
DLL	Wtsapi32.dll
Набор API	ext-ms-win-session-wtsapi32-l1-1-0 (представлено в Windows 8)

См. также раздел

WTSEnumerateSessions

WTSQuerySessionInformation