WTSQueryUserConfigA 関数 (wtsapi32.h)

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

構文

BOOL WTSQueryUserConfigA(
  [in]  LPSTR            pServerName,
  [in]  LPSTR            pUserName,
  [in]  WTS_CONFIG_CLASS WTSConfigClass,
  [out] LPSTR            *ppBuffer,
  [out] DWORD            *pBytesReturned
);

パラメーター

[in] pServerName

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

[in] pUserName

クエリを実行するユーザー名を含む null で終わる文字列へのポインター。 RD セッション ホスト サーバーの既定のユーザー設定を取得するには、このパラメーターを NULL に設定 します。

Windows Server 2008 と Windows Vista: このパラメーターを NULL に設定すると、エラーが返されます。

[in] WTSConfigClass

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

[out] ppBuffer

要求された情報へのポインターを受け取る変数へのポインター。 データの形式と内容は、 WTSConfigClass パラメーターで指定された情報クラスによって異なります。 返されたバッファーを解放するには、 WTSFreeMemory 関数を呼び出します。

[out] pBytesReturned

ppBuffer で返されるデータのサイズをバイト単位で受け取る変数へのポインター。

戻り値

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

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

解説

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

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

注意

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

要件

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

関連項目

WTSFreeMemory

WTSSetUserConfig

WTS_CONFIG_CLASS