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
ターゲット サーバーへのハンドル。
[in, out] pLevel
このパラメーターは予約されています。 このパラメーターは常に 1 に設定してください。 出力時に、WTSEnumerateSessionsEx
[in] Filter
このパラメーターは予約されています。 このパラメーターは常に 0 に設定してください。
[out] ppSessionInfo
WTS_SESSION_INFO_1 構造体の配列へのポインターを受け取る PWTS_SESSION_INFO_1 変数へのポインター。 配列内の各構造体には、指定された RD セッション ホスト サーバー上のセッションに関する情報が含まれています。
WTSOpenServerEx 関数を呼び出して RD 仮想化ホスト サーバーへのハンドルを取得した場合、配列にはサーバー上の仮想マシン上のセッションに関する情報が含まれます。 配列の使用が完了したら、WTSFreeMemoryEx 関数を呼び出して解放します。 また、ポインターを null
[out] pCount
ppSessionInfo バッファーで返される WTS_SESSION_INFO_1 構造体の数を受け取る DWORD 変数へのポインター。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError 関数を呼び出します。
備考
RD 仮想化ホスト サーバー上の仮想マシンで実行されているセッションに関する情報を取得するには、WTSOpenServerEx 関数を呼び出してハンドルを取得する必要があります。 返されたバッファーを解放するには、
セッションを列挙するには、そのセッションのクエリ情報アクセス許可が必要です。 詳細については、「リモート デスクトップ サービスのアクセス許可
RD 仮想化ホスト サーバーでホストされている仮想マシンで実行されているセッションを列挙するには、RD 仮想化ホスト サーバーの Administrators グループのメンバーである必要があります。
手記
wtsapi32.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして WTSEnumerateSessionsEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows 7 |
| サポートされる最小サーバー | Windows Server 2008 R2 |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | wtsapi32.h |
| ライブラリ | Wtsapi32.lib |
| DLL | Wtsapi32.dll |
| API セットの | ext-ms-win-session-wtsapi32-l1-1-0 (Windows 8 で導入) |
関連項目
WTSFreeMemoryEx を
WTSOpenServerEx の