WTSEnumerateListenersA-Funktion (wtsapi32.h)

Artikel
11/20/2024

Listet alle Remotedesktopdienste-Listener auf einem Remotedesktopsitzungshostserver (RD-Sitzungshost) auf.

Syntax

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

Parameter

[in] hServer

Ein Handle zu einem RD-Sitzungshostserver. Legen Sie diesen Parameter immer auf WTS_CURRENT_SERVER_HANDLEfest.

[in] pReserved

Dieser Parameter ist reserviert. Legen Sie diesen Parameter immer auf NULL-fest.

[in] Reserved

Dieser Parameter ist reserviert. Legen Sie diesen Parameter immer auf Null fest.

[out, optional] pListeners

Ein Zeiger auf ein Array von WTSLISTENERNAME Variablen, die die Namen der Listener empfangen.

[in, out] pCount

Ein Zeiger auf eine DWORD- Variable, die die Anzahl der Listenernamen im Array enthält, auf das durch den pListeners Parameter verwiesen wird. Wenn die Anzahl der Listenernamen unbekannt ist, übergeben Sie pListeners als NULL-. Die Funktion gibt die Anzahl der WTSLISTENERNAME Variablen zurück, die für das Array zugeordnet werden müssen, auf das der pListeners Parameter verweist.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Diese Funktion gibt alle Listener zurück, die derzeit auf dem Server ausgeführt werden, einschließlich Listenern, die remotedesktopprotokoll (RDP) nicht unterstützen.

Wenn die Anzahl der Listener unbekannt ist, können Sie diese Funktion mit pListeners aufrufen, auf NULL-festgelegt ist. Die Funktion gibt dann im parameter pCount die Anzahl der WTSLISTENERNAME Variablen zurück, die zum Empfangen aller Listener erforderlich sind. Weisen Sie das Array für pListeners basierend auf dieser Nummer zu, und rufen Sie die Funktion dann erneut auf, indem Sie pListeners auf das neu zugeordnete Array festlegen und pCount auf die vom ersten Aufruf zurückgegebene Nummer festlegen.

Anmerkung

Der wtsapi32.h-Header definiert WTSEnumerateListeners als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 7
mindestens unterstützte Server-	Windows Server 2008 R2
Zielplattform-	Fenster
Header-	wtsapi32.h
Library	Wtsapi32.lib
DLL-	Wtsapi32.dll

Freigeben über