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取得する情報の種類を示すWTS_VIRTUAL_CLASS列挙値。
ppBuffervoid**inout取得情報へのポインタを受け取る(出力、WTSFreeMemoryで解放)。
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 <MarshalAs(UnmanagedType.Bool)> 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)。
const std = @import("std");

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

typedef WTSVirtualChannelQueryNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>, Pointer<Uint32>);
typedef WTSVirtualChannelQueryDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>);
final WTSVirtualChannelQuery = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSVirtualChannelQueryNative, WTSVirtualChannelQueryDart>('WTSVirtualChannelQuery');
// hChannelHandle : HANDLE -> Pointer<Void>
// param1 : WTS_VIRTUAL_CLASS -> Int32
// ppBuffer : void** in/out -> Pointer<Void>
// pBytesReturned : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSVirtualChannelQuery"
  c_WTSVirtualChannelQuery :: Ptr () -> Int32 -> Ptr () -> Ptr Word32 -> IO CInt
-- hChannelHandle : HANDLE -> Ptr ()
-- param1 : WTS_VIRTUAL_CLASS -> Int32
-- ppBuffer : void** in/out -> Ptr ()
-- pBytesReturned : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtsvirtualchannelquery =
  foreign "WTSVirtualChannelQuery"
    ((ptr void) @-> int32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hChannelHandle : HANDLE -> (ptr void) *)
(* param1 : WTS_VIRTUAL_CLASS -> int32_t *)
(* ppBuffer : void** in/out -> (ptr void) *)
(* pBytesReturned : DWORD* in/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 ("WTSVirtualChannelQuery" wtsvirtual-channel-query :convention :stdcall) :int32
  (h-channel-handle :pointer)   ; HANDLE
  (param1 :int32)   ; WTS_VIRTUAL_CLASS
  (pp-buffer :pointer)   ; void** in/out
  (p-bytes-returned :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSVirtualChannelQuery = Win32::API::More->new('WTSAPI32',
    'BOOL WTSVirtualChannelQuery(HANDLE hChannelHandle, int param1, LPVOID ppBuffer, LPVOID pBytesReturned)');
# my $ret = $WTSVirtualChannelQuery->Call($hChannelHandle, $param1, $ppBuffer, $pBytesReturned);
# hChannelHandle : HANDLE -> HANDLE
# param1 : WTS_VIRTUAL_CLASS -> int
# ppBuffer : void** in/out -> LPVOID
# pBytesReturned : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型