WTSEnumerateListenersW 関数 (wtsapi32.h)

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

構文

BOOL WTSEnumerateListenersW(
  [in]            HANDLE            hServer,
  [in]            PVOID             pReserved,
  [in]            DWORD             Reserved,
  [out, optional] PWTSLISTENERNAMEW 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 変数へのポインター。 リスナー名の数が不明な場合は、pListenersNULLとして渡します。 この関数は、pListeners パラメーターが指す配列に割り当てるのに必要な WTSLISTENERNAME 変数の数 返します。

戻り値

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

関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError呼び出します。

備考

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

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

必要条件