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

WTSVirtualChannelQuery

関数
仮想チャネルに関する情報を照会する。
DLLWTSAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// WTSAPI32.dll
#include <windows.h>

BOOL WTSVirtualChannelQuery(
    HANDLE hChannelHandle,
    WTS_VIRTUAL_CLASS param1,
    void** ppBuffer,
    DWORD* pBytesReturned
);

パラメーター

名前方向
hChannelHandleHANDLEin
param1WTS_VIRTUAL_CLASSin
ppBuffervoid**inout
pBytesReturnedDWORD*inout

戻り値の型: BOOL

各言語での呼び出し定義

// WTSAPI32.dll
#include <windows.h>

BOOL WTSVirtualChannelQuery(
    HANDLE hChannelHandle,
    WTS_VIRTUAL_CLASS param1,
    void** ppBuffer,
    DWORD* pBytesReturned
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WTSVirtualChannelQuery(
    IntPtr hChannelHandle,   // HANDLE
    int param1,   // WTS_VIRTUAL_CLASS
    IntPtr ppBuffer,   // void** in/out
    ref uint pBytesReturned   // DWORD* in/out
);
<DllImport("WTSAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSVirtualChannelQuery(
    hChannelHandle As IntPtr,   ' HANDLE
    param1 As Integer,   ' WTS_VIRTUAL_CLASS
    ppBuffer As IntPtr,   ' void** in/out
    ByRef pBytesReturned As UInteger   ' DWORD* in/out
) As Boolean
End Function
' hChannelHandle : HANDLE
' param1 : WTS_VIRTUAL_CLASS
' ppBuffer : void** in/out
' pBytesReturned : DWORD* in/out
Declare PtrSafe Function WTSVirtualChannelQuery Lib "wtsapi32" ( _
    ByVal hChannelHandle As LongPtr, _
    ByVal param1 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

WTSVirtualChannelQuery = ctypes.windll.wtsapi32.WTSVirtualChannelQuery
WTSVirtualChannelQuery.restype = wintypes.BOOL
WTSVirtualChannelQuery.argtypes = [
    wintypes.HANDLE,  # hChannelHandle : HANDLE
    ctypes.c_int,  # param1 : WTS_VIRTUAL_CLASS
    ctypes.c_void_p,  # ppBuffer : void** in/out
    ctypes.POINTER(wintypes.DWORD),  # pBytesReturned : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSVirtualChannelQuery = Fiddle::Function.new(
  lib['WTSVirtualChannelQuery'],
  [
    Fiddle::TYPE_VOIDP,  # hChannelHandle : HANDLE
    Fiddle::TYPE_INT,  # param1 : WTS_VIRTUAL_CLASS
    Fiddle::TYPE_VOIDP,  # ppBuffer : void** in/out
    Fiddle::TYPE_VOIDP,  # pBytesReturned : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSVirtualChannelQuery(
        hChannelHandle: *mut core::ffi::c_void,  // HANDLE
        param1: i32,  // WTS_VIRTUAL_CLASS
        ppBuffer: *mut *mut (),  // void** in/out
        pBytesReturned: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", SetLastError = true)]
public static extern bool WTSVirtualChannelQuery(IntPtr hChannelHandle, int param1, IntPtr ppBuffer, ref uint pBytesReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSVirtualChannelQuery' -Namespace Win32 -PassThru
# $api::WTSVirtualChannelQuery(hChannelHandle, param1, ppBuffer, pBytesReturned)
#uselib "WTSAPI32.dll"
#func global WTSVirtualChannelQuery "WTSVirtualChannelQuery" sptr, sptr, sptr, sptr
; WTSVirtualChannelQuery hChannelHandle, param1, ppBuffer, varptr(pBytesReturned)   ; 戻り値は stat
; hChannelHandle : HANDLE -> "sptr"
; param1 : WTS_VIRTUAL_CLASS -> "sptr"
; ppBuffer : void** in/out -> "sptr"
; pBytesReturned : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelQuery "WTSVirtualChannelQuery" sptr, int, sptr, var
; res = WTSVirtualChannelQuery(hChannelHandle, param1, ppBuffer, pBytesReturned)
; hChannelHandle : HANDLE -> "sptr"
; param1 : WTS_VIRTUAL_CLASS -> "int"
; ppBuffer : void** in/out -> "sptr"
; pBytesReturned : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WTSVirtualChannelQuery(HANDLE hChannelHandle, WTS_VIRTUAL_CLASS param1, void** ppBuffer, DWORD* pBytesReturned)
#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelQuery "WTSVirtualChannelQuery" intptr, int, intptr, var
; res = WTSVirtualChannelQuery(hChannelHandle, param1, ppBuffer, pBytesReturned)
; hChannelHandle : HANDLE -> "intptr"
; param1 : WTS_VIRTUAL_CLASS -> "int"
; ppBuffer : void** in/out -> "intptr"
; pBytesReturned : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSVirtualChannelQuery = wtsapi32.NewProc("WTSVirtualChannelQuery")
)

// hChannelHandle (HANDLE), param1 (WTS_VIRTUAL_CLASS), ppBuffer (void** in/out), pBytesReturned (DWORD* in/out)
r1, _, err := procWTSVirtualChannelQuery.Call(
	uintptr(hChannelHandle),
	uintptr(param1),
	uintptr(ppBuffer),
	uintptr(pBytesReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSVirtualChannelQuery(
  hChannelHandle: THandle;   // HANDLE
  param1: Integer;   // WTS_VIRTUAL_CLASS
  ppBuffer: Pointer;   // void** in/out
  pBytesReturned: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSVirtualChannelQuery';
result := DllCall("WTSAPI32\WTSVirtualChannelQuery"
    , "Ptr", hChannelHandle   ; HANDLE
    , "Int", param1   ; WTS_VIRTUAL_CLASS
    , "Ptr", ppBuffer   ; void** in/out
    , "Ptr", pBytesReturned   ; DWORD* in/out
    , "Int")   ; return: BOOL
●WTSVirtualChannelQuery(hChannelHandle, param1, ppBuffer, pBytesReturned) = DLL("WTSAPI32.dll", "bool WTSVirtualChannelQuery(void*, int, void*, void*)")
# 呼び出し: WTSVirtualChannelQuery(hChannelHandle, param1, ppBuffer, pBytesReturned)
# hChannelHandle : HANDLE -> "void*"
# param1 : WTS_VIRTUAL_CLASS -> "int"
# ppBuffer : void** in/out -> "void*"
# pBytesReturned : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。