Win32 API 日本語リファレンス
ホーム › System.RemoteDesktop › WTSQueryUserConfigA

WTSQueryUserConfigA

関数
指定ユーザーの構成情報を取得する。
DLLWTSAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

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

パラメーター

名前型方向説明
pServerNameLPSTRin構成情報を取得するサーバー名を指すANSI文字列。NULLまたはローカルでローカルを対象。
pUserNameLPSTRin対象ユーザーのアカウント名を指すANSI文字列。
WTSConfigClassWTS_CONFIG_CLASSin取得するユーザー構成情報の種類を示す列挙値。
ppBufferLPSTR*out取得した構成情報へのポインタを受け取る(出力、WTSFreeMemoryで解放)。
pBytesReturnedDWORD*out返されたデータのバイト数を受け取るポインタ(出力)。

戻り値の型: BOOL

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数: 
; BOOL WTSQueryUserConfigA(LPSTR pServerName, LPSTR pUserName, WTS_CONFIG_CLASS WTSConfigClass, LPSTR* ppBuffer, DWORD* pBytesReturned)
#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 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSQueryUserConfigA = wtsapi32.NewProc("WTSQueryUserConfigA")
)

// pServerName (LPSTR), pUserName (LPSTR), WTSConfigClass (WTS_CONFIG_CLASS), ppBuffer (LPSTR* out), pBytesReturned (DWORD* out)
r1, _, err := procWTSQueryUserConfigA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pServerName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pUserName))),
	uintptr(WTSConfigClass),
	uintptr(ppBuffer),
	uintptr(pBytesReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSQueryUserConfigA(
  pServerName: PAnsiChar;   // LPSTR
  pUserName: PAnsiChar;   // LPSTR
  WTSConfigClass: Integer;   // WTS_CONFIG_CLASS
  ppBuffer: PPAnsiChar;   // LPSTR* out
  pBytesReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSQueryUserConfigA';
result := DllCall("WTSAPI32\WTSQueryUserConfigA"
    , "AStr", pServerName   ; LPSTR
    , "AStr", pUserName   ; LPSTR
    , "Int", WTSConfigClass   ; WTS_CONFIG_CLASS
    , "Ptr", ppBuffer   ; LPSTR* out
    , "Ptr", pBytesReturned   ; DWORD* out
    , "Int")   ; return: BOOL
●WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned) = DLL("WTSAPI32.dll", "bool WTSQueryUserConfigA(char*, char*, int, void*, void*)")
# 呼び出し: WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned)
# pServerName : LPSTR -> "char*"
# pUserName : LPSTR -> "char*"
# WTSConfigClass : WTS_CONFIG_CLASS -> "int"
# ppBuffer : LPSTR* out -> "void*"
# pBytesReturned : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wtsapi32" fn WTSQueryUserConfigA(
    pServerName: [*c]const u8, // LPSTR
    pUserName: [*c]const u8, // LPSTR
    WTSConfigClass: i32, // WTS_CONFIG_CLASS
    ppBuffer: [*c][*c]u8, // LPSTR* out
    pBytesReturned: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc WTSQueryUserConfigA(
    pServerName: cstring,  # LPSTR
    pUserName: cstring,  # LPSTR
    WTSConfigClass: int32,  # WTS_CONFIG_CLASS
    ppBuffer: ptr cstring,  # LPSTR* out
    pBytesReturned: ptr uint32  # DWORD* out
): int32 {.importc: "WTSQueryUserConfigA", stdcall, dynlib: "WTSAPI32.dll".}
pragma(lib, "wtsapi32");
extern(Windows)
int WTSQueryUserConfigA(
    const(char)* pServerName,   // LPSTR
    const(char)* pUserName,   // LPSTR
    int WTSConfigClass,   // WTS_CONFIG_CLASS
    char** ppBuffer,   // LPSTR* out
    uint* pBytesReturned   // DWORD* out
);
ccall((:WTSQueryUserConfigA, "WTSAPI32.dll"), stdcall, Int32,
      (Cstring, Cstring, Int32, Ptr{Ptr{UInt8}}, Ptr{UInt32}),
      pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned)
# pServerName : LPSTR -> Cstring
# pUserName : LPSTR -> Cstring
# WTSConfigClass : WTS_CONFIG_CLASS -> Int32
# ppBuffer : LPSTR* out -> Ptr{Ptr{UInt8}}
# pBytesReturned : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WTSQueryUserConfigA(
    const char* pServerName,
    const char* pUserName,
    int32_t WTSConfigClass,
    char** ppBuffer,
    uint32_t* pBytesReturned);
]]
local wtsapi32 = ffi.load("wtsapi32")
-- wtsapi32.WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned)
-- pServerName : LPSTR
-- pUserName : LPSTR
-- WTSConfigClass : WTS_CONFIG_CLASS
-- ppBuffer : LPSTR* out
-- pBytesReturned : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WTSAPI32.dll');
const WTSQueryUserConfigA = lib.func('__stdcall', 'WTSQueryUserConfigA', 'int32_t', ['str', 'str', 'int32_t', 'void *', 'uint32_t *']);
// WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned)
// pServerName : LPSTR -> 'str'
// pUserName : LPSTR -> 'str'
// WTSConfigClass : WTS_CONFIG_CLASS -> 'int32_t'
// ppBuffer : LPSTR* out -> 'void *'
// pBytesReturned : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WTSAPI32.dll", {
  WTSQueryUserConfigA: { parameters: ["buffer", "buffer", "i32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned)
// pServerName : LPSTR -> "buffer"
// pUserName : LPSTR -> "buffer"
// WTSConfigClass : WTS_CONFIG_CLASS -> "i32"
// ppBuffer : LPSTR* out -> "pointer"
// pBytesReturned : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WTSQueryUserConfigA(
    const char* pServerName,
    const char* pUserName,
    int32_t WTSConfigClass,
    char** ppBuffer,
    uint32_t* pBytesReturned);
C, "WTSAPI32.dll");
// $ffi->WTSQueryUserConfigA(pServerName, pUserName, WTSConfigClass, ppBuffer, pBytesReturned);
// pServerName : LPSTR
// pUserName : LPSTR
// WTSConfigClass : WTS_CONFIG_CLASS
// ppBuffer : LPSTR* out
// pBytesReturned : DWORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wtsapi32 extends StdCallLibrary {
    Wtsapi32 INSTANCE = Native.load("wtsapi32", Wtsapi32.class, W32APIOptions.ASCII_OPTIONS);
    boolean WTSQueryUserConfigA(
        String pServerName,   // LPSTR
        String pUserName,   // LPSTR
        int WTSConfigClass,   // WTS_CONFIG_CLASS
        PointerByReference ppBuffer,   // LPSTR* out
        IntByReference pBytesReturned   // DWORD* out
    );
}
@[Link("wtsapi32")]
lib LibWTSAPI32
  fun WTSQueryUserConfigA = WTSQueryUserConfigA(
    pServerName : UInt8*,   # LPSTR
    pUserName : UInt8*,   # LPSTR
    WTSConfigClass : Int32,   # WTS_CONFIG_CLASS
    ppBuffer : UInt8**,   # LPSTR* out
    pBytesReturned : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WTSQueryUserConfigANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32, Pointer<Pointer<Utf8>>, Pointer<Uint32>);
typedef WTSQueryUserConfigADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Pointer<Utf8>>, Pointer<Uint32>);
final WTSQueryUserConfigA = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSQueryUserConfigANative, WTSQueryUserConfigADart>('WTSQueryUserConfigA');
// pServerName : LPSTR -> Pointer<Utf8>
// pUserName : LPSTR -> Pointer<Utf8>
// WTSConfigClass : WTS_CONFIG_CLASS -> Int32
// ppBuffer : LPSTR* out -> Pointer<Pointer<Utf8>>
// pBytesReturned : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSQueryUserConfigA(
  pServerName: PAnsiChar;   // LPSTR
  pUserName: PAnsiChar;   // LPSTR
  WTSConfigClass: Integer;   // WTS_CONFIG_CLASS
  ppBuffer: PPAnsiChar;   // LPSTR* out
  pBytesReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSQueryUserConfigA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSQueryUserConfigA"
  c_WTSQueryUserConfigA :: CString -> CString -> Int32 -> Ptr CString -> Ptr Word32 -> IO CInt
-- pServerName : LPSTR -> CString
-- pUserName : LPSTR -> CString
-- WTSConfigClass : WTS_CONFIG_CLASS -> Int32
-- ppBuffer : LPSTR* out -> Ptr CString
-- pBytesReturned : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtsqueryuserconfiga =
  foreign "WTSQueryUserConfigA"
    (string @-> string @-> int32_t @-> (ptr string) @-> (ptr uint32_t) @-> returning int32_t)
(* pServerName : LPSTR -> string *)
(* pUserName : LPSTR -> string *)
(* WTSConfigClass : WTS_CONFIG_CLASS -> int32_t *)
(* ppBuffer : LPSTR* out -> (ptr string) *)
(* pBytesReturned : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wtsapi32 (t "WTSAPI32.dll"))
(cffi:use-foreign-library wtsapi32)

(cffi:defcfun ("WTSQueryUserConfigA" wtsquery-user-config-a :convention :stdcall) :int32
  (p-server-name :string)   ; LPSTR
  (p-user-name :string)   ; LPSTR
  (wtsconfig-class :int32)   ; WTS_CONFIG_CLASS
  (pp-buffer :pointer)   ; LPSTR* out
  (p-bytes-returned :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSQueryUserConfigA = Win32::API::More->new('WTSAPI32',
    'BOOL WTSQueryUserConfigA(LPCSTR pServerName, LPCSTR pUserName, int WTSConfigClass, LPVOID ppBuffer, LPVOID pBytesReturned)');
# my $ret = $WTSQueryUserConfigA->Call($pServerName, $pUserName, $WTSConfigClass, $ppBuffer, $pBytesReturned);
# pServerName : LPSTR -> LPCSTR
# pUserName : LPSTR -> LPCSTR
# WTSConfigClass : WTS_CONFIG_CLASS -> int
# ppBuffer : LPSTR* out -> LPVOID
# pBytesReturned : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型