ホーム › System.RemoteDesktop › WTSQueryUserConfigA

WTSQueryUserConfigA

関数

指定ユーザーの構成情報を取得する。

DLLWTSAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// WTSAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL WTSQueryUserConfigA(
    LPSTR pServerName,
    LPSTR pUserName,
    WTS_CONFIG_CLASS WTSConfigClass,
    LPSTR* ppBuffer,
    DWORD* pBytesReturned
);

パラメーター

名前	型	方向	説明
pServerName	LPSTR	in	ドメインコントローラーまたは RD セッションホストサーバーの名前を格納した、null で終わる文字列へのポインターです。アプリケーションが実行されている RD セッションホストサーバーを指定するには、WTS_CURRENT_SERVER_NAME を指定します。
pUserName	LPSTR	in	照会するユーザー名を格納した、null で終わる文字列へのポインターです。RD セッションホストサーバーの既定のユーザー設定を取得するには、このパラメーターを NULL に設定します。 Windows Server 2008 および Windows Vista: このパラメーターを NULL に設定するとエラーが返されます。
WTSConfigClass	WTS_CONFIG_CLASS	in	取得する情報の種類を指定します。このパラメーターには、 WTS_CONFIG_CLASS 列挙型の値のいずれかを指定できます。情報の種類ごとに ppBuffer に返されるデータの形式については、 WTS_CONFIG_CLASS のドキュメントで説明しています。
ppBuffer	LPSTR*	out	要求した情報へのポインターを受け取る変数へのポインターです。データの形式と内容は、WTSConfigClass パラメーターで指定した情報クラスによって異なります。返されたバッファーを解放するには、 WTSFreeMemory 関数を呼び出します。
pBytesReturned	DWORD*	out	ppBuffer に返されるデータのサイズ (バイト単位) を受け取る変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

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

ユーザー構成情報の設定と照会は、任意のドメインコントローラーで行えます。ドメインコントローラーの名前を取得するには、 DsGetDcName 関数を使用します。

メモ

wtsapi32.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして WTSQueryUserConfig を定義しています。エンコーディング中立でないコードでエンコーディング中立のエイリアスを混用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、「関数プロトタイプの規則」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WTSAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL WTSQueryUserConfigA(
    LPSTR pServerName,
    LPSTR pUserName,
    WTS_CONFIG_CLASS WTSConfigClass,
    LPSTR* ppBuffer,
    DWORD* pBytesReturned
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WTSQueryUserConfigA(
    [MarshalAs(UnmanagedType.LPStr)] string pServerName,   // LPSTR
    [MarshalAs(UnmanagedType.LPStr)] string pUserName,   // LPSTR
    int WTSConfigClass,   // WTS_CONFIG_CLASS
    IntPtr ppBuffer,   // LPSTR* out
    out uint pBytesReturned   // DWORD* out
);

<DllImport("WTSAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSQueryUserConfigA(
    <MarshalAs(UnmanagedType.LPStr)> pServerName As String,   ' LPSTR
    <MarshalAs(UnmanagedType.LPStr)> pUserName As String,   ' LPSTR
    WTSConfigClass As Integer,   ' WTS_CONFIG_CLASS
    ppBuffer As IntPtr,   ' LPSTR* out
    <Out> ByRef pBytesReturned As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pServerName : LPSTR
' pUserName : LPSTR
' WTSConfigClass : WTS_CONFIG_CLASS
' ppBuffer : LPSTR* out
' pBytesReturned : DWORD* out
Declare PtrSafe Function WTSQueryUserConfigA Lib "wtsapi32" ( _
    ByVal pServerName As String, _
    ByVal pUserName As String, _
    ByVal WTSConfigClass As Long, _
    ByVal ppBuffer As LongPtr, _
    ByRef pBytesReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WTSQueryUserConfigA = ctypes.windll.wtsapi32.WTSQueryUserConfigA
WTSQueryUserConfigA.restype = wintypes.BOOL
WTSQueryUserConfigA.argtypes = [
    wintypes.LPCSTR,  # pServerName : LPSTR
    wintypes.LPCSTR,  # pUserName : LPSTR
    ctypes.c_int,  # WTSConfigClass : WTS_CONFIG_CLASS
    ctypes.c_void_p,  # ppBuffer : LPSTR* out
    ctypes.POINTER(wintypes.DWORD),  # pBytesReturned : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSQueryUserConfigA = Fiddle::Function.new(
  lib['WTSQueryUserConfigA'],
  [
    Fiddle::TYPE_VOIDP,  # pServerName : LPSTR
    Fiddle::TYPE_VOIDP,  # pUserName : LPSTR
    Fiddle::TYPE_INT,  # WTSConfigClass : WTS_CONFIG_CLASS
    Fiddle::TYPE_VOIDP,  # ppBuffer : LPSTR* out
    Fiddle::TYPE_VOIDP,  # pBytesReturned : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wtsapi32")]
extern "system" {
    fn WTSQueryUserConfigA(
        pServerName: *mut u8,  // LPSTR
        pUserName: *mut u8,  // LPSTR
        WTSConfigClass: i32,  // WTS_CONFIG_CLASS
        ppBuffer: *mut *mut u8,  // LPSTR* out
        pBytesReturned: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool WTSQueryUserConfigA([MarshalAs(UnmanagedType.LPStr)] string pServerName, [MarshalAs(UnmanagedType.LPStr)] string pUserName, int WTSConfigClass, IntPtr ppBuffer, out uint pBytesReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSQueryUserConfigA' -Namespace Win32 -PassThru
# $api::WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned)

#uselib "WTSAPI32.dll"
#func global WTSQueryUserConfigA "WTSQueryUserConfigA" sptr, sptr, sptr, sptr, sptr
; WTSQueryUserConfigA pServerName, pUserName, WTSConfigClass, varptr(ppBuffer), varptr(pBytesReturned)   ; 戻り値は stat
; pServerName : LPSTR -> "sptr"
; pUserName : LPSTR -> "sptr"
; WTSConfigClass : WTS_CONFIG_CLASS -> "sptr"
; ppBuffer : LPSTR* out -> "sptr"
; pBytesReturned : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WTSAPI32.dll"
#cfunc global WTSQueryUserConfigA "WTSQueryUserConfigA" str, str, int, var, var
; res = WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned)
; pServerName : LPSTR -> "str"
; pUserName : LPSTR -> "str"
; WTSConfigClass : WTS_CONFIG_CLASS -> "int"
; ppBuffer : LPSTR* out -> "var"
; pBytesReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WTSAPI32.dll"
#cfunc global WTSQueryUserConfigA "WTSQueryUserConfigA" str, str, int, sptr, sptr
; res = WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, varptr(ppBuffer), varptr(pBytesReturned))
; pServerName : LPSTR -> "str"
; pUserName : LPSTR -> "str"
; WTSConfigClass : WTS_CONFIG_CLASS -> "int"
; ppBuffer : LPSTR* out -> "sptr"
; pBytesReturned : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。