Funzione WTSEnumerateSessionsA (wtsapi32.h)

Articolo
08/28/2023

Recupera un elenco di sessioni in un server Host sessione Desktop remoto (Host sessione Desktop remoto).

Sintassi

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

Parametri

[in] hServer

Handle per il server Host sessione Desktop remoto.

Nota È possibile usare le funzioni WTSOpenServer o WTSOpenServerEx per recuperare un handle in un server specifico oppure WTS_CURRENT_SERVER_HANDLE usare il server Host sessione Desktop remoto che ospita l'applicazione.

[in] Reserved

Questo parametro è riservato. Deve essere zero.

[in] Version

Versione della richiesta di enumerazione. Questo parametro deve essere 1.

[out] ppSessionInfo

Puntatore a una matrice di strutture WTS_SESSION_INFO che rappresentano le sessioni recuperate. Per liberare il buffer restituito, chiamare la funzione WTSFreeMemory .

Autorizzazioni di sessione:

Per enumerare una sessione, è necessario abilitare l'autorizzazione relativa alle informazioni sulla query. Per altre informazioni, vedere Autorizzazioni di Servizi Desktop remoto.
Per modificare le autorizzazioni per una sessione, usare lo strumento di amministrazione configurazione di Servizi Desktop remoto.
Per enumerare le sessioni in esecuzione in una macchina virtuale ospitata in un server Host di virtualizzazione Desktop remoto, è necessario essere membri del gruppo Administrators nel server Host di virtualizzazione Desktop remoto.

[out] pCount

Puntatore al numero di strutture WTS_SESSION_INFO restituite nel parametro ppSessionInfo .

Valore restituito

Restituisce zero se questa funzione ha esito negativo. Se questa funzione ha esito positivo, viene restituito un valore diverso da zero.

Per informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

Nota

L'intestazione wtsapi32.h definisce WTSEnumerateSessions come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista
Server minimo supportato	Windows Server 2008
Piattaforma di destinazione	Windows
Intestazione	wtsapi32.h
Libreria	Wtsapi32.lib
DLL	Wtsapi32.dll
Set di API	ext-ms-win-session-wtsapi32-l1-1-0 (introdotto in Windows 8)

Vedi anche

WTS_SESSION_INFO

Condividi tramite