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

WTSQueryListenerConfigA

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

シグネチャ

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

BOOL WTSQueryListenerConfigA(
    HANDLE hServer,   // optional
    void* pReserved,
    DWORD Reserved,
    LPSTR pListenerName,
    WTSLISTENERCONFIGA* pBuffer
);

パラメーター

名前型方向説明
hServerHANDLEinoptional対象RDサーバーのハンドル。ローカルにはWTS_CURRENT_SERVER_HANDLEを指定。
pReservedvoid*in予約済み。NULLを指定する。
ReservedDWORDin予約済み。必ず0を指定する。
pListenerNameLPSTRin構成を取得するリスナー名を指すANSI文字列。
pBufferWTSLISTENERCONFIGA*outリスナー構成を受け取るWTSLISTENERCONFIGA構造体へのポインタ(出力)。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WTSQueryListenerConfigA(
    HANDLE hServer,   // optional
    void* pReserved,
    DWORD Reserved,
    LPSTR pListenerName,
    WTSLISTENERCONFIGA* pBuffer
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WTSQueryListenerConfigA(
    IntPtr hServer,   // HANDLE optional
    IntPtr pReserved,   // void*
    uint Reserved,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string pListenerName,   // LPSTR
    IntPtr pBuffer   // WTSLISTENERCONFIGA* out
);
<DllImport("WTSAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSQueryListenerConfigA(
    hServer As IntPtr,   ' HANDLE optional
    pReserved As IntPtr,   ' void*
    Reserved As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pListenerName As String,   ' LPSTR
    pBuffer As IntPtr   ' WTSLISTENERCONFIGA* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hServer : HANDLE optional
' pReserved : void*
' Reserved : DWORD
' pListenerName : LPSTR
' pBuffer : WTSLISTENERCONFIGA* out
Declare PtrSafe Function WTSQueryListenerConfigA Lib "wtsapi32" ( _
    ByVal hServer As LongPtr, _
    ByVal pReserved As LongPtr, _
    ByVal Reserved As Long, _
    ByVal pListenerName As String, _
    ByVal pBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WTSQueryListenerConfigA = ctypes.windll.wtsapi32.WTSQueryListenerConfigA
WTSQueryListenerConfigA.restype = wintypes.BOOL
WTSQueryListenerConfigA.argtypes = [
    wintypes.HANDLE,  # hServer : HANDLE optional
    ctypes.POINTER(None),  # pReserved : void*
    wintypes.DWORD,  # Reserved : DWORD
    wintypes.LPCSTR,  # pListenerName : LPSTR
    ctypes.c_void_p,  # pBuffer : WTSLISTENERCONFIGA* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSQueryListenerConfigA = Fiddle::Function.new(
  lib['WTSQueryListenerConfigA'],
  [
    Fiddle::TYPE_VOIDP,  # hServer : HANDLE optional
    Fiddle::TYPE_VOIDP,  # pReserved : void*
    -Fiddle::TYPE_INT,  # Reserved : DWORD
    Fiddle::TYPE_VOIDP,  # pListenerName : LPSTR
    Fiddle::TYPE_VOIDP,  # pBuffer : WTSLISTENERCONFIGA* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSQueryListenerConfigA(
        hServer: *mut core::ffi::c_void,  // HANDLE optional
        pReserved: *mut (),  // void*
        Reserved: u32,  // DWORD
        pListenerName: *mut u8,  // LPSTR
        pBuffer: *mut WTSLISTENERCONFIGA  // WTSLISTENERCONFIGA* 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 WTSQueryListenerConfigA(IntPtr hServer, IntPtr pReserved, uint Reserved, [MarshalAs(UnmanagedType.LPStr)] string pListenerName, IntPtr pBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSQueryListenerConfigA' -Namespace Win32 -PassThru
# $api::WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer)
#uselib "WTSAPI32.dll"
#func global WTSQueryListenerConfigA "WTSQueryListenerConfigA" sptr, sptr, sptr, sptr, sptr
; WTSQueryListenerConfigA hServer, pReserved, Reserved, pListenerName, varptr(pBuffer)   ; 戻り値は stat
; hServer : HANDLE optional -> "sptr"
; pReserved : void* -> "sptr"
; Reserved : DWORD -> "sptr"
; pListenerName : LPSTR -> "sptr"
; pBuffer : WTSLISTENERCONFIGA* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "WTSAPI32.dll"
#cfunc global WTSQueryListenerConfigA "WTSQueryListenerConfigA" sptr, sptr, int, str, var
; res = WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer)
; hServer : HANDLE optional -> "sptr"
; pReserved : void* -> "sptr"
; Reserved : DWORD -> "int"
; pListenerName : LPSTR -> "str"
; pBuffer : WTSLISTENERCONFIGA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL WTSQueryListenerConfigA(HANDLE hServer, void* pReserved, DWORD Reserved, LPSTR pListenerName, WTSLISTENERCONFIGA* pBuffer)
#uselib "WTSAPI32.dll"
#cfunc global WTSQueryListenerConfigA "WTSQueryListenerConfigA" intptr, intptr, int, str, var
; res = WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer)
; hServer : HANDLE optional -> "intptr"
; pReserved : void* -> "intptr"
; Reserved : DWORD -> "int"
; pListenerName : LPSTR -> "str"
; pBuffer : WTSLISTENERCONFIGA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSQueryListenerConfigA = wtsapi32.NewProc("WTSQueryListenerConfigA")
)

// hServer (HANDLE optional), pReserved (void*), Reserved (DWORD), pListenerName (LPSTR), pBuffer (WTSLISTENERCONFIGA* out)
r1, _, err := procWTSQueryListenerConfigA.Call(
	uintptr(hServer),
	uintptr(pReserved),
	uintptr(Reserved),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pListenerName))),
	uintptr(pBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSQueryListenerConfigA(
  hServer: THandle;   // HANDLE optional
  pReserved: Pointer;   // void*
  Reserved: DWORD;   // DWORD
  pListenerName: PAnsiChar;   // LPSTR
  pBuffer: Pointer   // WTSLISTENERCONFIGA* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSQueryListenerConfigA';
result := DllCall("WTSAPI32\WTSQueryListenerConfigA"
    , "Ptr", hServer   ; HANDLE optional
    , "Ptr", pReserved   ; void*
    , "UInt", Reserved   ; DWORD
    , "AStr", pListenerName   ; LPSTR
    , "Ptr", pBuffer   ; WTSLISTENERCONFIGA* out
    , "Int")   ; return: BOOL
●WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer) = DLL("WTSAPI32.dll", "bool WTSQueryListenerConfigA(void*, void*, dword, char*, void*)")
# 呼び出し: WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer)
# hServer : HANDLE optional -> "void*"
# pReserved : void* -> "void*"
# Reserved : DWORD -> "dword"
# pListenerName : LPSTR -> "char*"
# pBuffer : WTSLISTENERCONFIGA* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wtsapi32" fn WTSQueryListenerConfigA(
    hServer: ?*anyopaque, // HANDLE optional
    pReserved: ?*anyopaque, // void*
    Reserved: u32, // DWORD
    pListenerName: [*c]const u8, // LPSTR
    pBuffer: [*c]WTSLISTENERCONFIGA // WTSLISTENERCONFIGA* out
) callconv(std.os.windows.WINAPI) i32;
proc WTSQueryListenerConfigA(
    hServer: pointer,  # HANDLE optional
    pReserved: pointer,  # void*
    Reserved: uint32,  # DWORD
    pListenerName: cstring,  # LPSTR
    pBuffer: ptr WTSLISTENERCONFIGA  # WTSLISTENERCONFIGA* out
): int32 {.importc: "WTSQueryListenerConfigA", stdcall, dynlib: "WTSAPI32.dll".}
pragma(lib, "wtsapi32");
extern(Windows)
int WTSQueryListenerConfigA(
    void* hServer,   // HANDLE optional
    void* pReserved,   // void*
    uint Reserved,   // DWORD
    const(char)* pListenerName,   // LPSTR
    WTSLISTENERCONFIGA* pBuffer   // WTSLISTENERCONFIGA* out
);
ccall((:WTSQueryListenerConfigA, "WTSAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Cstring, Ptr{WTSLISTENERCONFIGA}),
      hServer, pReserved, Reserved, pListenerName, pBuffer)
# hServer : HANDLE optional -> Ptr{Cvoid}
# pReserved : void* -> Ptr{Cvoid}
# Reserved : DWORD -> UInt32
# pListenerName : LPSTR -> Cstring
# pBuffer : WTSLISTENERCONFIGA* out -> Ptr{WTSLISTENERCONFIGA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WTSQueryListenerConfigA(
    void* hServer,
    void* pReserved,
    uint32_t Reserved,
    const char* pListenerName,
    void* pBuffer);
]]
local wtsapi32 = ffi.load("wtsapi32")
-- wtsapi32.WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer)
-- hServer : HANDLE optional
-- pReserved : void*
-- Reserved : DWORD
-- pListenerName : LPSTR
-- pBuffer : WTSLISTENERCONFIGA* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WTSAPI32.dll');
const WTSQueryListenerConfigA = lib.func('__stdcall', 'WTSQueryListenerConfigA', 'int32_t', ['void *', 'void *', 'uint32_t', 'str', 'void *']);
// WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer)
// hServer : HANDLE optional -> 'void *'
// pReserved : void* -> 'void *'
// Reserved : DWORD -> 'uint32_t'
// pListenerName : LPSTR -> 'str'
// pBuffer : WTSLISTENERCONFIGA* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WTSAPI32.dll", {
  WTSQueryListenerConfigA: { parameters: ["pointer", "pointer", "u32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer)
// hServer : HANDLE optional -> "pointer"
// pReserved : void* -> "pointer"
// Reserved : DWORD -> "u32"
// pListenerName : LPSTR -> "buffer"
// pBuffer : WTSLISTENERCONFIGA* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WTSQueryListenerConfigA(
    void* hServer,
    void* pReserved,
    uint32_t Reserved,
    const char* pListenerName,
    void* pBuffer);
C, "WTSAPI32.dll");
// $ffi->WTSQueryListenerConfigA(hServer, pReserved, Reserved, pListenerName, pBuffer);
// hServer : HANDLE optional
// pReserved : void*
// Reserved : DWORD
// pListenerName : LPSTR
// pBuffer : WTSLISTENERCONFIGA* 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 WTSQueryListenerConfigA(
        Pointer hServer,   // HANDLE optional
        Pointer pReserved,   // void*
        int Reserved,   // DWORD
        String pListenerName,   // LPSTR
        Pointer pBuffer   // WTSLISTENERCONFIGA* out
    );
}
@[Link("wtsapi32")]
lib LibWTSAPI32
  fun WTSQueryListenerConfigA = WTSQueryListenerConfigA(
    hServer : Void*,   # HANDLE optional
    pReserved : Void*,   # void*
    Reserved : UInt32,   # DWORD
    pListenerName : UInt8*,   # LPSTR
    pBuffer : WTSLISTENERCONFIGA*   # WTSLISTENERCONFIGA* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WTSQueryListenerConfigANative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Utf8>, Pointer<Void>);
typedef WTSQueryListenerConfigADart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Utf8>, Pointer<Void>);
final WTSQueryListenerConfigA = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSQueryListenerConfigANative, WTSQueryListenerConfigADart>('WTSQueryListenerConfigA');
// hServer : HANDLE optional -> Pointer<Void>
// pReserved : void* -> Pointer<Void>
// Reserved : DWORD -> Uint32
// pListenerName : LPSTR -> Pointer<Utf8>
// pBuffer : WTSLISTENERCONFIGA* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSQueryListenerConfigA(
  hServer: THandle;   // HANDLE optional
  pReserved: Pointer;   // void*
  Reserved: DWORD;   // DWORD
  pListenerName: PAnsiChar;   // LPSTR
  pBuffer: Pointer   // WTSLISTENERCONFIGA* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSQueryListenerConfigA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSQueryListenerConfigA"
  c_WTSQueryListenerConfigA :: Ptr () -> Ptr () -> Word32 -> CString -> Ptr () -> IO CInt
-- hServer : HANDLE optional -> Ptr ()
-- pReserved : void* -> Ptr ()
-- Reserved : DWORD -> Word32
-- pListenerName : LPSTR -> CString
-- pBuffer : WTSLISTENERCONFIGA* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtsquerylistenerconfiga =
  foreign "WTSQueryListenerConfigA"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> string @-> (ptr void) @-> returning int32_t)
(* hServer : HANDLE optional -> (ptr void) *)
(* pReserved : void* -> (ptr void) *)
(* Reserved : DWORD -> uint32_t *)
(* pListenerName : LPSTR -> string *)
(* pBuffer : WTSLISTENERCONFIGA* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wtsapi32 (t "WTSAPI32.dll"))
(cffi:use-foreign-library wtsapi32)

(cffi:defcfun ("WTSQueryListenerConfigA" wtsquery-listener-config-a :convention :stdcall) :int32
  (h-server :pointer)   ; HANDLE optional
  (p-reserved :pointer)   ; void*
  (reserved :uint32)   ; DWORD
  (p-listener-name :string)   ; LPSTR
  (p-buffer :pointer))   ; WTSLISTENERCONFIGA* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSQueryListenerConfigA = Win32::API::More->new('WTSAPI32',
    'BOOL WTSQueryListenerConfigA(HANDLE hServer, LPVOID pReserved, DWORD Reserved, LPCSTR pListenerName, LPVOID pBuffer)');
# my $ret = $WTSQueryListenerConfigA->Call($hServer, $pReserved, $Reserved, $pListenerName, $pBuffer);
# hServer : HANDLE optional -> HANDLE
# pReserved : void* -> LPVOID
# Reserved : DWORD -> DWORD
# pListenerName : LPSTR -> LPCSTR
# pBuffer : WTSLISTENERCONFIGA* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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