WTSEnumerateSessionsExA 関数 (wtsapi32.h)

指定したリモート デスクトップ セッション ホスト (RD セッション ホスト) サーバーまたはリモート デスクトップ仮想化ホスト (RD 仮想化ホスト) サーバー上のセッションの一覧を取得します。

構文

BOOL WTSEnumerateSessionsExA(
  [in]      HANDLE               hServer,
  [in, out] DWORD                *pLevel,
  [in]      DWORD                Filter,
  [out]     PWTS_SESSION_INFO_1A *ppSessionInfo,
  [out]     DWORD                *pCount
);

パラメーター

[in] hServer

ターゲット サーバーへのハンドル。 WTSOpenServer または WTSOpenServerEx 関数によって返されるハンドルを指定します。 アプリケーションが実行されている RD セッション ホスト サーバー上のセッションを列挙するには、 WTS_CURRENT_SERVER_HANDLEを指定します。

[in, out] pLevel

このパラメーターは予約されています。 常に、このパラメーターを 1 に設定します。 出力時に 、WTSEnumerateSessionsEx はこの パラメーターの値を変更しません。

[in] Filter

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

[out] ppSessionInfo

構造体の配列へのポインターを受け取る PWTS_SESSION_INFO_1 変数へのポインター WTS_SESSION_INFO_1 。 配列内の各構造体には、指定された RD セッション ホスト サーバー上のセッションに関する情報が含まれています。 WTSOpenServerEx 関数を呼び出して RD 仮想化ホスト サーバーへのハンドルを取得した場合、配列にはサーバー上の仮想マシン上のセッションに関する情報が含まれます。 配列の使用が完了したら、 WTSFreeMemoryEx 関数を呼び出して解放します。 ポインターを NULL に設定する必要もあります。

[out] pCount

ppSessionInfo バッファーで返されるWTS_SESSION_INFO_1構造体の数を受け取る DWORD 変数へのポインター。

戻り値

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

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

注釈

RD 仮想化ホスト サーバー上の仮想マシンで実行されているセッションに関する情報を取得するには、 WTSOpenServerEx 関数を呼び出してハンドルを取得する必要があります。 返されたバッファーを解放するには、 WTSFreeMemoryEx 関数を呼び出し、 WTSClassType パラメーターを WTSTypeSessionInfoLevel1 に設定します。

セッションを列挙するには、そのセッションのクエリ情報アクセス許可が必要です。 詳細については、「 リモート デスクトップ サービスのアクセス許可」を参照してください。 セッションのアクセス許可を変更するには、リモート デスクトップ サービス構成管理ツールを使用します。

RD 仮想化ホスト サーバーでホストされている仮想マシンで実行されているセッションを列挙するには、RD 仮想化ホスト サーバーの Administrators グループのメンバーである必要があります。

注意

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

要件

要件	値
サポートされている最小のクライアント	Windows 7
サポートされている最小のサーバー	Windows Server 2008 R2
対象プラットフォーム	Windows
ヘッダー	wtsapi32.h
Library	Wtsapi32.lib
[DLL]	Wtsapi32.dll
API セット	ext-ms-win-session-wtsapi32-l1-1-0 (Windows 8で導入)

こちらもご覧ください

WTSFreeMemoryEx

WTSOpenServerEx

WTS_SESSION_INFO_1