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

WTSSetListenerSecurityA

関数
指定リスナーのセキュリティ記述子を設定する。
DLLWTSAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL WTSSetListenerSecurityA(
    HANDLE hServer,   // optional
    void* pReserved,
    DWORD Reserved,
    LPSTR pListenerName,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor
);

パラメーター

名前型方向説明
hServerHANDLEinoptional対象RDセッションホストサーバーのハンドル。ローカルなら WTS_CURRENT_SERVER_HANDLE を指定する。
pReservedvoid*in予約済みパラメーター。常に NULL を指定する。
ReservedDWORDin予約済みパラメーター。常に 0 を指定する。
pListenerNameLPSTRinセキュリティを設定する対象リスナーの名前を指すANSI文字列ポインター。
SecurityInformationOBJECT_SECURITY_INFORMATIONin設定するセキュリティ情報の種類を示すフラグ。DACL/SACL/所有者などを指定する。
pSecurityDescriptorPSECURITY_DESCRIPTORinリスナーに適用するセキュリティ記述子へのポインター。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSSetListenerSecurityA = Fiddle::Function.new(
  lib['WTSSetListenerSecurityA'],
  [
    Fiddle::TYPE_VOIDP,  # hServer : HANDLE optional
    Fiddle::TYPE_VOIDP,  # pReserved : void*
    -Fiddle::TYPE_INT,  # Reserved : DWORD
    Fiddle::TYPE_VOIDP,  # pListenerName : LPSTR
    -Fiddle::TYPE_INT,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
  ],
  Fiddle::TYPE_INT)
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSSetListenerSecurityA(
        hServer: *mut core::ffi::c_void,  // HANDLE optional
        pReserved: *mut (),  // void*
        Reserved: u32,  // DWORD
        pListenerName: *mut u8,  // LPSTR
        SecurityInformation: u32,  // OBJECT_SECURITY_INFORMATION
        pSecurityDescriptor: *mut core::ffi::c_void  // PSECURITY_DESCRIPTOR
    ) -> 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 WTSSetListenerSecurityA(IntPtr hServer, IntPtr pReserved, uint Reserved, [MarshalAs(UnmanagedType.LPStr)] string pListenerName, uint SecurityInformation, IntPtr pSecurityDescriptor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSSetListenerSecurityA' -Namespace Win32 -PassThru
# $api::WTSSetListenerSecurityA(hServer, pReserved, Reserved, pListenerName, SecurityInformation, pSecurityDescriptor)
#uselib "WTSAPI32.dll"
#func global WTSSetListenerSecurityA "WTSSetListenerSecurityA" sptr, sptr, sptr, sptr, sptr, sptr
; WTSSetListenerSecurityA hServer, pReserved, Reserved, pListenerName, SecurityInformation, pSecurityDescriptor   ; 戻り値は stat
; hServer : HANDLE optional -> "sptr"
; pReserved : void* -> "sptr"
; Reserved : DWORD -> "sptr"
; pListenerName : LPSTR -> "sptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "sptr"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WTSAPI32.dll"
#cfunc global WTSSetListenerSecurityA "WTSSetListenerSecurityA" sptr, sptr, int, str, int, sptr
; res = WTSSetListenerSecurityA(hServer, pReserved, Reserved, pListenerName, SecurityInformation, pSecurityDescriptor)
; hServer : HANDLE optional -> "sptr"
; pReserved : void* -> "sptr"
; Reserved : DWORD -> "int"
; pListenerName : LPSTR -> "str"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; BOOL WTSSetListenerSecurityA(HANDLE hServer, void* pReserved, DWORD Reserved, LPSTR pListenerName, OBJECT_SECURITY_INFORMATION SecurityInformation, PSECURITY_DESCRIPTOR pSecurityDescriptor)
#uselib "WTSAPI32.dll"
#cfunc global WTSSetListenerSecurityA "WTSSetListenerSecurityA" intptr, intptr, int, str, int, intptr
; res = WTSSetListenerSecurityA(hServer, pReserved, Reserved, pListenerName, SecurityInformation, pSecurityDescriptor)
; hServer : HANDLE optional -> "intptr"
; pReserved : void* -> "intptr"
; Reserved : DWORD -> "int"
; pListenerName : LPSTR -> "str"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSSetListenerSecurityA = wtsapi32.NewProc("WTSSetListenerSecurityA")
)

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

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

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

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

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

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

関連項目

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