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

Статья
03/04/2024

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

Синтаксис

BOOL WTSEnumerateProcessesExA(
  [in]      HANDLE hServer,
  [in, out] DWORD  *pLevel,
  [in]      DWORD  SessionId,
  [out]     LPSTR  *ppProcessInfo,
  [out]     DWORD  *pCount
);

Параметры

[in] hServer

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

[in, out] pLevel

Указатель на переменную DWORD , которая при входных данных указывает тип возвращаемых сведений. Чтобы вернуть массив WTS_PROCESS_INFO структур, укажите ноль. Чтобы вернуть массив WTS_PROCESS_INFO_EX структур, укажите один из них.

Если не указать допустимое значение для этого параметра, в выходных данных WTSEnumerateProcessesEx присваивает этому параметру значение 1 и возвращает ошибку. В противном случае в выходных данных WTSEnumerateProcessesEx не изменяет значение этого параметра.

[in] SessionId

Сеанс, для которого выполняется перечисление процессов. Чтобы перечислить процессы для всех сеансов на сервере, укажите WTS_ANY_SESSION.

[out] ppProcessInfo

Указатель на переменную, получающую указатель на массив WTS_PROCESS_INFO или WTS_PROCESS_INFO_EX структур. Тип структуры определяется значением, передаваемым параметру pLevel . Каждая структура в массиве содержит сведения об активном процессе. Завершив использование массива, освободите его, вызвав функцию WTSFreeMemoryEx . Также следует задать для указателя значение NULL.

[out] pCount

Указатель на переменную, получающую число
структуры, возвращаемые в буфере, на который ссылается параметр ppProcessInfo .

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

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

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

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

Требования

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

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

WTSOpenServer

WTS_PROCESS_INFO

WTS_PROCESS_INFO_EX