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

Статья
11/20/2024

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

Синтаксис

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
целевая платформа	Виндоус
заголовка	wtsapi32.h
библиотеки	Wtsapi32.lib
DLL	Wtsapi32.dll
набор API	ext-ms-win-session-wtsapi32-l1-1-0 (представлено в Windows 8)

См. также

WTS_SESSION_INFO

Поделиться через