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

Статья
11/20/2024

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

Синтаксис

BOOL WTSEnumerateServersA(
  [in] LPSTR             pDomainName,
  [in] DWORD             Reserved,
  [in] DWORD             Version,
       PWTS_SERVER_INFOA *ppServerInfo,
       DWORD             *pCount
);

Параметры

[in] pDomainName

Указатель на имя домена для запроса. Если значение этого параметра NULL, указанный домен является текущим доменом.

[in] Reserved

Скрытный. Значение этого параметра должно быть равно 0.

[in] Version

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

ppServerInfo

Указывает на массив структур WTS_SERVER_INFO, содержащий возвращаемые результаты перечисления. После использования память, используемая этим буфером, должна быть освобождена путем вызова WTSFreeMemory.

pCount

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

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

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

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

Замечания

Эта функция не будет работать, если NetBT отключен.

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows Vista
минимальный поддерживаемый сервер	Windows Server 2008
целевая платформа	Виндоус
заголовка	wtsapi32.h
библиотеки	Wtsapi32.lib
DLL	Wtsapi32.dll

См. также

WTS_SERVER_INFO

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