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

Статья
08/28/2023

Извлекает список сеансов на сервере узла сеансов удаленных рабочих столов (узел сеансов удаленных рабочих столов).

Синтаксис

BOOL WTSEnumerateSessionsA(
  [in]  HANDLE             hServer,
  [in]  DWORD              Reserved,
  [in]  DWORD              Version,
  [out] PWTS_SESSION_INFOA *ppSessionInfo,
  [out] DWORD              *pCount
);

Параметры

[in] hServer

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

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

[in] Reserved

Этот параметр зарезервирован. Оно должно быть равно нулю.

[in] Version

Версия запроса перечисления. Этот параметр должен иметь значение 1.

[out] ppSessionInfo

Указатель на массив WTS_SESSION_INFO структур, представляющих извлеченные сеансы. Чтобы освободить возвращенный буфер, вызовите функцию WTSFreeMemory .

Разрешения сеанса:

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

[out] pCount

Указатель на количество WTS_SESSION_INFO структур, возвращаемых в параметре ppSessionInfo .

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

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

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

Заголовок wtsapi32.h определяет WTSEnumerateSessions в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	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)

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

WTS_SESSION_INFO

Share via