Funzione WTSEnumerateSessionsExW (wtsapi32.h)

Articolo
11/20/2024

Recupera un elenco di sessioni in un server Host sessione Desktop remoto (Host sessione Desktop remoto) o in un server Host di virtualizzazione Desktop remoto (Rd Virtualization Host).

Sintassi

BOOL WTSEnumerateSessionsExW(
  [in]      HANDLE               hServer,
  [in, out] DWORD                *pLevel,
  [in]      DWORD                Filter,
  [out]     PWTS_SESSION_INFO_1W *ppSessionInfo,
  [out]     DWORD                *pCount
);

Parametri

[in] hServer

Handle per il server di destinazione. Specificare un handle restituito dalla funzione WTSOpenServer o WTSOpenServerEx. Per enumerare le sessioni nel server Host sessione Desktop remoto in cui è in esecuzione l'applicazione, specificare WTS_CURRENT_SERVER_HANDLE.

[in, out] pLevel

Questo parametro è riservato. Impostare sempre questo parametro su uno. Nell'output WTSEnumerateSessionsEx non modifica il valore di questo parametro.

[in] Filter

Questo parametro è riservato. Impostare sempre questo parametro su zero.

[out] ppSessionInfo

Puntatore a una variabile PWTS_SESSION_INFO_1 che riceve un puntatore a una matrice di strutture WTS_SESSION_INFO_1. Ogni struttura nella matrice contiene informazioni su una sessione nel server Host sessione Desktop remoto specificato. Se è stato ottenuto un handle per un server host di virtualizzazione Desktop remoto chiamando la funzione WTSOpenServerEx , l'array contiene informazioni sulle sessioni nelle macchine virtuali nel server. Al termine dell'uso della matrice, liberarla chiamando la funzione WTSFreeMemoryEx . È anche necessario impostare il puntatore su NULL.

[out] pCount

Puntatore a una variabile DWORD che riceve il numero di strutture WTS_SESSION_INFO_1 restituite nel buffer ppSessionInfo.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è un valore diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per ottenere informazioni estese sull'errore, chiamare la funzione GetLastError .

Osservazioni

Per ottenere informazioni sulle sessioni in esecuzione in macchine virtuali in un server Host di virtualizzazione Desktop remoto, è necessario ottenere l'handle chiamando la funzione WTSOpenServerEx . Per liberare il buffer restituito, chiamare la funzione WTSFreeMemoryEx e impostare il parametro WTSClassType su WTSTypeSessionInfoLevel1.

Per enumerare una sessione, è necessario disporre dell'autorizzazione Query Information per tale sessione. 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.

Nota

L'intestazione wtsapi32.h definisce WTSEnumerateSessionsEx 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 non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

Requisito	Valore
client minimo supportato	Windows 7
server minimo supportato	Windows Server 2008 R2
piattaforma di destinazione	Finestre
intestazione	wtsapi32.h
libreria	Wtsapi32.lib
dll	Wtsapi32.dll
set di API	ext-ms-win-session-wtsapi32-l1-1-0 (introdotto in Windows 8)

Vedere anche

WTSFreeMemoryEx

WTSOpenServerEx

WTS_SESSION_INFO_1

Condividi tramite