WTSEnumerateSessionsA 関数 (wtsapi32.h)

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

構文

BOOL WTSEnumerateSessionsA(
  [in]  HANDLE             hServer,
  [in]  DWORD              Reserved,
  [in]  DWORD              Version,
  [out] PWTS_SESSION_INFOA *ppSessionInfo,
  [out] DWORD              *pCount
);

パラメーター

[in] hServer

RD セッション ホスト サーバーへのハンドル。

メモWTSOpenServer 関数または WTSOpenServerEx 関数を使用して、特定のサーバーへのハンドルを取得したり、アプリケーションをホストする RD セッション ホスト サーバーを使用WTS_CURRENT_SERVER_HANDLEしたりできます。

 

[in] Reserved

このパラメーターは予約されています。 0 にする必要があります。

[in] Version

列挙要求のバージョン。 このパラメーターは 1 である必要があります。

[out] ppSessionInfo

取得したセッションを表す WTS_SESSION_INFO 構造体の配列へのポインター。 返されたバッファーを解放するには、 WTSFreeMemory 関数を呼び出します。

セッションのアクセス許可:

• セッションを列挙するには、クエリ情報のアクセス許可を有効にする必要があります。 詳細については、「 リモート デスクトップ サービスのアクセス許可」を参照してください。
• セッションのアクセス許可を変更するには、リモート デスクトップ サービス構成管理ツールを使用します。
• RD 仮想化ホスト サーバーでホストされている仮想マシンで実行されているセッションを列挙するには、RD 仮想化ホスト サーバーの Administrators グループのメンバーである必要があります。

[out] pCount

ppSessionInfo パラメーターで返されるWTS_SESSION_INFO構造体の数へのポインター。

戻り値

この関数が失敗した場合は、0 を返します。 この関数が成功すると、0 以外の値が返されます。

詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

注意

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

要件

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

こちらもご覧ください

WTS_SESSION_INFO