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

WTSCreateListenerA

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

シグネチャ

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

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

パラメーター

名前型方向説明
hServerHANDLEinoptional対象RDサーバーのハンドル。ローカルにはWTS_CURRENT_SERVER_HANDLEを指定。
pReservedvoid*in予約済み。NULLを指定する。
ReservedDWORDin予約済み。必ず0を指定する。
pListenerNameLPSTRin作成または構成するリスナー名を指すANSI文字列。
pBufferWTSLISTENERCONFIGA*inリスナー構成を格納したWTSLISTENERCONFIGA構造体へのポインタ(入力)。
flagDWORDin作成動作を制御するフラグ(WTS_LC_CREATE等)。既存上書き等を指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

WTSCreateListenerA = ctypes.windll.wtsapi32.WTSCreateListenerA
WTSCreateListenerA.restype = wintypes.BOOL
WTSCreateListenerA.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*
    wintypes.DWORD,  # flag : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSCreateListenerA = wtsapi32.NewProc("WTSCreateListenerA")
)

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

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

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

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

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

(cffi:defcfun ("WTSCreateListenerA" wtscreate-listener-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*
  (flag :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSCreateListenerA = Win32::API::More->new('WTSAPI32',
    'BOOL WTSCreateListenerA(HANDLE hServer, LPVOID pReserved, DWORD Reserved, LPCSTR pListenerName, LPVOID pBuffer, DWORD flag)');
# my $ret = $WTSCreateListenerA->Call($hServer, $pReserved, $Reserved, $pListenerName, $pBuffer, $flag);
# hServer : HANDLE optional -> HANDLE
# pReserved : void* -> LPVOID
# Reserved : DWORD -> DWORD
# pListenerName : LPSTR -> LPCSTR
# pBuffer : WTSLISTENERCONFIGA* -> LPVOID
# flag : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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