Funzione WTSQuerySessionInformationW (wtsapi32.h)

Articolo
11/20/2024

Recupera le informazioni sulla sessione specificata nel server Host sessione Desktop remoto (Host sessione Desktop remoto) specificato. Può essere usato per eseguire query sulle informazioni di sessione sui server Host sessione Desktop remoto locale e remoto.

Sintassi

BOOL WTSQuerySessionInformationW(
  [in]  HANDLE         hServer,
  [in]  DWORD          SessionId,
  [in]  WTS_INFO_CLASS WTSInfoClass,
  [out] LPWSTR         *ppBuffer,
  [out] DWORD          *pBytesReturned
);

Parametri

[in] hServer

Handle per un server Host sessione Desktop remoto. Specificare un handle aperto dalla funzione WTSOpenServer oppure specificare WTS_CURRENT_SERVER_HANDLE per indicare il server Host sessione Desktop remoto in cui è in esecuzione l'applicazione.

[in] SessionId

Identificatore di sessione di Servizi Desktop remoto. Per indicare la sessione in cui è in esecuzione l'applicazione chiamante (o la sessione corrente) specificare WTS_CURRENT_SESSION. Specificare WTS_CURRENT_SESSION solo quando si ottengono informazioni sulla sessione nel server locale. Se WTS_CURRENT_SESSION viene specificato quando si eseguono query sulle informazioni sulla sessione in un server remoto, le informazioni di sessione restituite non saranno coerenti. Non usare i dati restituiti.

È possibile usare la funzione WTSEnumerateSessions per recuperare gli identificatori di tutte le sessioni in un server Host sessione Desktop remoto specificato.

Per eseguire query sulle informazioni per la sessione di un altro utente, è necessario disporre dell'autorizzazione Query Information (Informazioni 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.

[in] WTSInfoClass

Valore dell'enumerazione WTS_INFO_CLASS che indica il tipo di informazioni sulla sessione da recuperare in una chiamata alla funzione WTSQuerySessionInformation .

[out] ppBuffer

Puntatore a una variabile che riceve un puntatore alle informazioni richieste. Il formato e il contenuto dei dati dipendono dalla classe di informazioni specificata nel parametro WTSInfoClass . Per liberare il buffer restituito, chiamare la funzione WTSFreeMemory .

[out] pBytesReturned

Puntatore a una variabile che riceve le dimensioni, in byte, dei dati restituiti in ppBuffer.

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 GetLastError.

Osservazioni

Per recuperare l'ID sessione per la sessione corrente quando Servizi Desktop remoto è in esecuzione, chiamare WTSQuerySessionInformation e specificare WTS_CURRENT_SESSION per il parametro SessionId e WTSSessionId per il parametro WTSInfoClass. L'ID sessione verrà restituito nel parametro ppBuffer. Se Servizi Desktop remoto non è in esecuzione, le chiamate a WTSQuerySessionInformation hanno esito negativo. In questo caso, è possibile recuperare l'ID sessione corrente chiamando la funzione ProcessIdToSessionId .

Per determinare se l'applicazione è in esecuzione nella console fisica, è necessario specificare WTS_CURRENT_SESSION per il parametro SessionId e WTSClientProtocolType come parametro WTSInfoClass. Se ppBuffer è "0", la sessione viene collegata alla console fisica.

Nota

L'intestazione wtsapi32.h definisce WTSQuerySessionInformation 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 Vista
server minimo supportato	Windows Server 2008
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)