WTSSetUserConfigA 関数 (wtsapi32.h)

指定したドメイン コントローラーまたはリモート デスクトップ セッション ホスト (RD セッション ホスト) サーバー上の指定したユーザーの構成情報を変更します。

構文

BOOL WTSSetUserConfigA(
  [in] LPSTR            pServerName,
  [in] LPSTR            pUserName,
  [in] WTS_CONFIG_CLASS WTSConfigClass,
  [in] LPSTR            pBuffer,
  [in] DWORD            DataLength
);

パラメーター

[in] pServerName

ドメイン コントローラーまたは RD セッション ホスト サーバーの名前を含む null で終わる文字列へのポインター。 アプリケーションが実行されている RD セッション ホスト サーバーを示すには、WTS_CURRENT_SERVER_NAMEを指定します。

[in] pUserName

構成が設定されているユーザーの名前を含む null で終わる文字列へのポインター。

[in] WTSConfigClass

ユーザーに設定する情報の種類を指定します。 このパラメーターには、 WTS_CONFIG_CLASS 列挙型の値のいずれかを指定できます。 WTS_CONFIG_CLASSのドキュメントでは、各情報の種類について ppBuffer で指定されたデータの形式について説明します。

[in] pBuffer

指定したユーザーの構成を変更するために使用されるデータへのポインター。

[in] DataLength

pBuffer バッファーの TCHAR 単位のサイズ。

戻り値

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

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

解説

ユーザー アカウント情報は多くの場合、ドメイン コントローラー上に存在するため、 WTSQueryUserConfig 関数と WTSSetUserConfig 関数には、ハンドルの代わりにサーバー名が渡されます。 ユーザー構成情報を設定するには、プライマリ ドメイン コントローラーを使用します。 NetGetDCName 関数を呼び出して、プライマリ ドメイン コントローラーの名前を取得できます。 ユーザー構成情報のクエリを実行するには、 NetGetAnyDCName 関数を使用して、プライマリ ドメイン コントローラーまたはバックアップ ドメイン コントローラーの名前を取得します。

どのドメイン コントローラーでも、ユーザー構成情報を設定または照会できます。 DsGetDcName 関数を使用して、ドメイン コントローラーの名前を取得します。

WTSConfigClass パラメーターの値がWTS_CONFIG_CLASS列挙の整数値に対応する場合は、DWORD として設定する値を定義します。 次の例のように、WTSSetUserConfig の呼び出しで値を LPWSTR にキャストします。

WTSSetUserConfig( strServer.GetBuffer(0), 
                  m_strName.GetBuffer(0), 
                  WTSUserConfigfAllowLogonTerminalServer, 
                  (LPWSTR) &dwEnable, 
                  sizeof(DWORD));

注意

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

要件

要件	値
サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
対象プラットフォーム	Windows
ヘッダー	wtsapi32.h
Library	Wtsapi32.lib
[DLL]	Wtsapi32.dll

こちらもご覧ください

WTSQueryUserConfig

WTS_CONFIG_CLASS