Funzione WTSEnumerateListenersA (wtsapi32.h)

Articolo
08/28/2023

Enumera tutti i listener di Servizi Desktop remoto in un server Host sessione Desktop remoto (Host sessione Desktop remoto).

Sintassi

BOOL WTSEnumerateListenersA(
  [in]            HANDLE            hServer,
  [in]            PVOID             pReserved,
  [in]            DWORD             Reserved,
  [out, optional] PWTSLISTENERNAMEA pListeners,
  [in, out]       DWORD             *pCount
);

Parametri

[in] hServer

Handle per un server host sessione Desktop remoto. Impostare sempre questo parametro su WTS_CURRENT_SERVER_HANDLE.

[in] pReserved

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

[in] Reserved

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

[out, optional] pListeners

Puntatore a una matrice di variabili WTSLISTENERNAME che ricevono i nomi dei listener.

[in, out] pCount

Puntatore a una variabile DWORD contenente il numero di nomi del listener nella matrice a cui fa riferimento il parametro pListeners . Se il numero di nomi del listener è sconosciuto, passare pListeners come NULL. La funzione restituirà il numero di variabili WTSLISTENERNAME necessarie per allocare la matrice a cui punta il parametro pListeners .

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 informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

Questa funzione restituisce tutti i listener attualmente in esecuzione nel server, inclusi i listener che non supportano Remote Desktop Protocol (RDP).

Se il numero di listener è sconosciuto, è possibile chiamare questa funzione con pListeners impostata su NULL. La funzione restituirà quindi, nel parametro pCount , il numero di variabili WTSLISTENERNAME necessarie per ricevere tutti i listener. Allocare la matrice per pListeners in base a questo numero e quindi chiamare di nuovo la funzione, impostando pListeners sulla matrice appena allocata e pCount sul numero restituito dalla prima chiamata.

Nota

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

Requisiti

Requisito	Valore
Client minimo supportato	Windows 7
Server minimo supportato	Windows Server 2008 R2
Piattaforma di destinazione	Windows
Intestazione	wtsapi32.h
Libreria	Wtsapi32.lib
DLL	Wtsapi32.dll

Condividi tramite