WTSEnumerateListenersA 関数 (wtsapi32.h)

リモート デスクトップ セッション ホスト (RD セッション ホスト) サーバー上のすべてのリモート デスクトップ サービス リスナーを列挙します。

構文

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

パラメーター

[in] hServer

RD セッション ホスト サーバーへのハンドル。 このパラメーターは常に WTS_CURRENT_SERVER_HANDLEに設定してください。

[in] pReserved

このパラメーターは予約されています。 このパラメーターは常に NULL に設定してください。

[in] Reserved

このパラメーターは予約されています。 常に、このパラメーターを 0 に設定します。

[out, optional] pListeners

リスナーの名前を受け取る WTSLISTENERNAME 変数の配列へのポインター。

[in, out] pCount

pListeners パラメーターによって参照される配列内のリスナー名の数を含む DWORD 変数へのポインター。 リスナー名の数が不明な場合は、 pListenersを NULL として渡します。 この関数は、pListeners パラメーターが指す配列に割り当てるのに必要な WTSLISTENERNAME 変数の数を返します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

この関数は、リモート デスクトップ プロトコル (RDP) をサポートしていないリスナーを含め、サーバーで現在実行されているすべてのリスナーを返します。

リスナーの数が不明な場合は、 pListeners を NULL に設定してこの関数を呼び出すことができます。 その後、関数は pCount パラメーターで、すべてのリスナーを受け取るために必要な WTSLISTENERNAME 変数の数を返します。 この番号に基づいて pListeners の配列を割り当ててから、関数をもう一度呼び出し、 pListeners を新しく割り当てられた配列に設定し、 pCount を 最初の呼び出しで返された番号に設定します。

注意

wtsapi32.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして WTSEnumerateListeners を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 7
サポートされている最小のサーバー	Windows Server 2008 R2
対象プラットフォーム	Windows
ヘッダー	wtsapi32.h
Library	Wtsapi32.lib
[DLL]	Wtsapi32.dll