WTSUSERCONFIGA 構造体 (wtsapi32.h)
ドメイン コントローラーまたはリモート デスクトップ セッション ホスト (RD セッション ホスト) サーバー上のユーザーの構成情報が含まれます。 この構造体は、 WTSQueryUserConfig 関数と WTSSetUserConfig 関数で使用されます。
構文
typedef struct _WTSUSERCONFIGA {
DWORD Source;
DWORD InheritInitialProgram;
DWORD AllowLogonTerminalServer;
DWORD TimeoutSettingsConnections;
DWORD TimeoutSettingsDisconnections;
DWORD TimeoutSettingsIdle;
DWORD DeviceClientDrives;
DWORD DeviceClientPrinters;
DWORD ClientDefaultPrinter;
DWORD BrokenTimeoutSettings;
DWORD ReconnectSettings;
DWORD ShadowingSettings;
DWORD TerminalServerRemoteHomeDir;
CHAR InitialProgram[MAX_PATH + 1];
CHAR WorkDirectory[MAX_PATH + 1];
CHAR TerminalServerProfilePath[MAX_PATH + 1];
CHAR TerminalServerHomeDir[MAX_PATH + 1];
CHAR TerminalServerHomeDirDrive[WTS_DRIVE_LENGTH + 1];
} WTSUSERCONFIGA, *PWTSUSERCONFIGA;
メンバー
Source
WTSQueryUserConfig 関数によって返される構成情報のソースを指定する、WTS_CONFIG_SOURCE列挙型の値。
InheritInitialProgram
クライアントが初期プログラムを指定できるかどうかを示す 値。 このメンバーには、次のいずれかの値を指定できます。
0
クライアントは初期プログラムを指定できません。 代わりに、 InitialProgram メンバーによって指定されたプログラムは、ユーザーがサーバーにログオンすると自動的に開始されます。 サーバーは、ユーザーがそのプログラムを終了したときにユーザーをログオフします。
1
クライアントは初期プログラムを指定できます。
AllowLogonTerminalServer
ユーザー アカウントが RD セッション ホスト サーバーへのログオンを許可されているかどうかを示す 値です。 このメンバーには、次のいずれかの値を指定できます。
0
ユーザーはログオンできません。
1
ユーザーはログオンできます。
TimeoutSettingsConnections
最大接続時間 (ミリ秒単位)。 接続の有効期限が切れる 1 分前に、サーバーは保留中の切断についてユーザーに通知します。 接続がタイムアウトすると、サーバーは BrokenTimeoutSettings メンバーによって指定されたアクションを実行します。 ユーザーがログオンするたびに、タイマーがリセットされます。 値 0 は、接続タイマーが無効になっていることを示します。
TimeoutSettingsDisconnections
ログオンが終了する前にサーバーが切断されたセッションを保持する最大時間 (ミリ秒単位)。 値 0 は、切断タイマーが無効になっていることを示します。
TimeoutSettingsIdle
接続がアイドル状態を維持できる時間 (ミリ秒単位)。 この期間にキーボードまたはマウスのアクティビティがない場合、サーバーは BrokenTimeoutSettings メンバーによって指定されたアクションを実行します。 値 0 は、アイドル タイマーが無効になっていることを示します。
DeviceClientDrives
このメンバーは予約されています。
DeviceClientPrinters
ユーザーがサーバーにログオンしたときに、サーバーが以前にマップされたクライアント プリンターに自動的に接続するかどうかを示す 値。 このメンバーには、次のいずれかの値を指定できます。
0
サーバーは、以前にマップされたクライアント プリンターに自動的に接続しません。
1
サーバーは、以前にマップされたクライアント プリンターに自動的に接続します。
ClientDefaultPrinter
クライアント プリンターが既定のプリンターかどうかを示す 値です。 このメンバーには、次のいずれかの値を指定できます。
0
クライアント プリンターが既定のプリンターではありません。
1
クライアント プリンターが既定のプリンターです。
BrokenTimeoutSettings
接続タイマーまたはアイドル タイマーの有効期限が切れたとき、または接続エラーが原因で接続が失われた場合に、サーバーが実行するアクション。 このメンバーには、次のいずれかの値を指定できます。
0
セッションは切断されていますが、サーバー上に残ります。
1
セッションが終了します。
ReconnectSettings
このユーザーの切断されたセッションを再接続する方法を示す 値。 このメンバーには、次のいずれかの値を指定できます。
0
ユーザーは、切断されたセッションに再接続するために、任意のクライアント コンピューターにログオンできます。
1
ユーザーは、切断されたセッションを確立するために最初に使用されたクライアント コンピューターにログオンする必要があります。 ユーザーが別のクライアント コンピューターにログオンすると、ユーザーは新しいセッションを取得します。
ShadowingSettings
リモート コントロールの設定。 リモート コントロールを使用すると、ユーザーは別のユーザーの画面上の操作をリモートで監視できます。 このメンバーには、次のいずれかの値を指定できます。
0
リモート コントロールが無効になっています。
1
リモート コントロールのユーザーは、ユーザーのアクセス許可を使用して、ユーザーのセッションを完全に制御できます。
2
リモート コントロールのユーザーは、ユーザーのセッションを完全に制御できます。ユーザーのアクセス許可は必要ありません。
3
リモート コントロールのユーザーは、ユーザーのアクセス許可を使用して、セッションをリモートで表示できます。リモート ユーザーはセッションをアクティブに制御できません。
4
リモート コントロールのユーザーはセッションをリモートで表示できますが、セッションをアクティブに制御することはできません。ユーザーのアクセス許可は必要ありません。
TerminalServerRemoteHomeDir
TerminalServerHomeDir メンバーにローカル ディレクトリまたはネットワーク共有へのパスが含まれているかどうかを示す 値です。 WTSSetUserConfig 関数を使用してこのメンバーを設定することはできません。 このメンバーには、次のいずれかの値を指定できます。
0
TerminalServerHomeDir メンバーには、ローカル ディレクトリへのパスが含まれています。
1
TerminalServerHomeDir メンバーにはネットワーク共有へのパスが含まれており、TerminalServerHomeDirDrive メンバーには、このパスがマップされるドライブ文字が含まれています。
InitialProgram[MAX_PATH + 1]
ユーザーがサーバーにログオンした直後に開始するプログラムの名前を含む null で終わる文字列。
WorkDirectory[MAX_PATH + 1]
最初のプログラムの作業ディレクトリのパスを含む null で終わる文字列。
TerminalServerProfilePath[MAX_PATH + 1]
ユーザーがサーバーに接続するときにユーザーに割り当てられるプロファイル パスを含む null で終わる文字列。 パスで指定されたディレクトリは手動で作成する必要があり、ログオン前に存在する必要があります。
TerminalServerHomeDir[MAX_PATH + 1]
ユーザーのリモート デスクトップ サービス セッションのホーム フォルダーへのパスを含む null で終わる文字列。 フォルダーには、ローカル フォルダーまたはネットワーク共有を指定できます。
TerminalServerHomeDirDrive[WTS_DRIVE_LENGTH + 1]
TerminalServerHomeDir メンバーで指定されたパスがマップされるドライブ名 (ドライブ文字の後にコロンが続く) を含む null で終わる文字列。 このメンバーは、 TerminalServerRemoteHomeDir メンバーが 1 に設定されている場合にのみ有効です。
解説
注意
wtsapi32.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして WTSUSERCONFIG を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows 7 |
| サポートされている最小のサーバー | Windows Server 2008 R2 |
| Header | wtsapi32.h |