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

WTSSetRenderHint

関数
ウィンドウの描画ヒントをRDSへ設定する。
DLLWTSAPI32.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT WTSSetRenderHint(
    ULONGLONG* pRenderHintID,
    HWND hwndOwner,
    DWORD renderHintType,
    DWORD cbHintDataLength,
    BYTE* pHintData   // optional
);

パラメーター

名前方向説明
pRenderHintIDULONGLONG*inoutレンダーヒントの一意IDを受け渡しする64ビット値へのポインター。初回は新規IDを受け取る。
hwndOwnerHWNDinヒントの対象となるウィンドウのハンドル。
renderHintTypeDWORDin設定するレンダーヒントの種類を示す値。
cbHintDataLengthDWORDinpHintData が指すヒントデータのサイズ(バイト単位)。
pHintDataBYTE*inoptionalヒントの種類に応じたデータを格納したバッファーへのポインター。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WTSSetRenderHint(
    ULONGLONG* pRenderHintID,
    HWND hwndOwner,
    DWORD renderHintType,
    DWORD cbHintDataLength,
    BYTE* pHintData   // optional
);
[DllImport("WTSAPI32.dll", ExactSpelling = true)]
static extern int WTSSetRenderHint(
    ref ulong pRenderHintID,   // ULONGLONG* in/out
    IntPtr hwndOwner,   // HWND
    uint renderHintType,   // DWORD
    uint cbHintDataLength,   // DWORD
    IntPtr pHintData   // BYTE* optional
);
<DllImport("WTSAPI32.dll", ExactSpelling:=True)>
Public Shared Function WTSSetRenderHint(
    ByRef pRenderHintID As ULong,   ' ULONGLONG* in/out
    hwndOwner As IntPtr,   ' HWND
    renderHintType As UInteger,   ' DWORD
    cbHintDataLength As UInteger,   ' DWORD
    pHintData As IntPtr   ' BYTE* optional
) As Integer
End Function
' pRenderHintID : ULONGLONG* in/out
' hwndOwner : HWND
' renderHintType : DWORD
' cbHintDataLength : DWORD
' pHintData : BYTE* optional
Declare PtrSafe Function WTSSetRenderHint Lib "wtsapi32" ( _
    ByRef pRenderHintID As LongLong, _
    ByVal hwndOwner As LongPtr, _
    ByVal renderHintType As Long, _
    ByVal cbHintDataLength As Long, _
    ByVal pHintData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WTSSetRenderHint = ctypes.windll.wtsapi32.WTSSetRenderHint
WTSSetRenderHint.restype = ctypes.c_int
WTSSetRenderHint.argtypes = [
    ctypes.POINTER(ctypes.c_ulonglong),  # pRenderHintID : ULONGLONG* in/out
    wintypes.HANDLE,  # hwndOwner : HWND
    wintypes.DWORD,  # renderHintType : DWORD
    wintypes.DWORD,  # cbHintDataLength : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pHintData : BYTE* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSSetRenderHint = Fiddle::Function.new(
  lib['WTSSetRenderHint'],
  [
    Fiddle::TYPE_VOIDP,  # pRenderHintID : ULONGLONG* in/out
    Fiddle::TYPE_VOIDP,  # hwndOwner : HWND
    -Fiddle::TYPE_INT,  # renderHintType : DWORD
    -Fiddle::TYPE_INT,  # cbHintDataLength : DWORD
    Fiddle::TYPE_VOIDP,  # pHintData : BYTE* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSSetRenderHint(
        pRenderHintID: *mut u64,  // ULONGLONG* in/out
        hwndOwner: *mut core::ffi::c_void,  // HWND
        renderHintType: u32,  // DWORD
        cbHintDataLength: u32,  // DWORD
        pHintData: *mut u8  // BYTE* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WTSAPI32.dll")]
public static extern int WTSSetRenderHint(ref ulong pRenderHintID, IntPtr hwndOwner, uint renderHintType, uint cbHintDataLength, IntPtr pHintData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSSetRenderHint' -Namespace Win32 -PassThru
# $api::WTSSetRenderHint(pRenderHintID, hwndOwner, renderHintType, cbHintDataLength, pHintData)
#uselib "WTSAPI32.dll"
#func global WTSSetRenderHint "WTSSetRenderHint" sptr, sptr, sptr, sptr, sptr
; WTSSetRenderHint varptr(pRenderHintID), hwndOwner, renderHintType, cbHintDataLength, varptr(pHintData)   ; 戻り値は stat
; pRenderHintID : ULONGLONG* in/out -> "sptr"
; hwndOwner : HWND -> "sptr"
; renderHintType : DWORD -> "sptr"
; cbHintDataLength : DWORD -> "sptr"
; pHintData : BYTE* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WTSAPI32.dll"
#cfunc global WTSSetRenderHint "WTSSetRenderHint" var, sptr, int, int, var
; res = WTSSetRenderHint(pRenderHintID, hwndOwner, renderHintType, cbHintDataLength, pHintData)
; pRenderHintID : ULONGLONG* in/out -> "var"
; hwndOwner : HWND -> "sptr"
; renderHintType : DWORD -> "int"
; cbHintDataLength : DWORD -> "int"
; pHintData : BYTE* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT WTSSetRenderHint(ULONGLONG* pRenderHintID, HWND hwndOwner, DWORD renderHintType, DWORD cbHintDataLength, BYTE* pHintData)
#uselib "WTSAPI32.dll"
#cfunc global WTSSetRenderHint "WTSSetRenderHint" var, intptr, int, int, var
; res = WTSSetRenderHint(pRenderHintID, hwndOwner, renderHintType, cbHintDataLength, pHintData)
; pRenderHintID : ULONGLONG* in/out -> "var"
; hwndOwner : HWND -> "intptr"
; renderHintType : DWORD -> "int"
; cbHintDataLength : DWORD -> "int"
; pHintData : BYTE* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSSetRenderHint = wtsapi32.NewProc("WTSSetRenderHint")
)

// pRenderHintID (ULONGLONG* in/out), hwndOwner (HWND), renderHintType (DWORD), cbHintDataLength (DWORD), pHintData (BYTE* optional)
r1, _, err := procWTSSetRenderHint.Call(
	uintptr(pRenderHintID),
	uintptr(hwndOwner),
	uintptr(renderHintType),
	uintptr(cbHintDataLength),
	uintptr(pHintData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WTSSetRenderHint(
  pRenderHintID: Pointer;   // ULONGLONG* in/out
  hwndOwner: THandle;   // HWND
  renderHintType: DWORD;   // DWORD
  cbHintDataLength: DWORD;   // DWORD
  pHintData: Pointer   // BYTE* optional
): Integer; stdcall;
  external 'WTSAPI32.dll' name 'WTSSetRenderHint';
result := DllCall("WTSAPI32\WTSSetRenderHint"
    , "Ptr", pRenderHintID   ; ULONGLONG* in/out
    , "Ptr", hwndOwner   ; HWND
    , "UInt", renderHintType   ; DWORD
    , "UInt", cbHintDataLength   ; DWORD
    , "Ptr", pHintData   ; BYTE* optional
    , "Int")   ; return: HRESULT
●WTSSetRenderHint(pRenderHintID, hwndOwner, renderHintType, cbHintDataLength, pHintData) = DLL("WTSAPI32.dll", "int WTSSetRenderHint(void*, void*, dword, dword, void*)")
# 呼び出し: WTSSetRenderHint(pRenderHintID, hwndOwner, renderHintType, cbHintDataLength, pHintData)
# pRenderHintID : ULONGLONG* in/out -> "void*"
# hwndOwner : HWND -> "void*"
# renderHintType : DWORD -> "dword"
# cbHintDataLength : DWORD -> "dword"
# pHintData : BYTE* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WTSSetRenderHintNative = Int32 Function(Pointer<Uint64>, Pointer<Void>, Uint32, Uint32, Pointer<Uint8>);
typedef WTSSetRenderHintDart = int Function(Pointer<Uint64>, Pointer<Void>, int, int, Pointer<Uint8>);
final WTSSetRenderHint = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSSetRenderHintNative, WTSSetRenderHintDart>('WTSSetRenderHint');
// pRenderHintID : ULONGLONG* in/out -> Pointer<Uint64>
// hwndOwner : HWND -> Pointer<Void>
// renderHintType : DWORD -> Uint32
// cbHintDataLength : DWORD -> Uint32
// pHintData : BYTE* optional -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSSetRenderHint(
  pRenderHintID: Pointer;   // ULONGLONG* in/out
  hwndOwner: THandle;   // HWND
  renderHintType: DWORD;   // DWORD
  cbHintDataLength: DWORD;   // DWORD
  pHintData: Pointer   // BYTE* optional
): Integer; stdcall;
  external 'WTSAPI32.dll' name 'WTSSetRenderHint';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSSetRenderHint"
  c_WTSSetRenderHint :: Ptr Word64 -> Ptr () -> Word32 -> Word32 -> Ptr Word8 -> IO Int32
-- pRenderHintID : ULONGLONG* in/out -> Ptr Word64
-- hwndOwner : HWND -> Ptr ()
-- renderHintType : DWORD -> Word32
-- cbHintDataLength : DWORD -> Word32
-- pHintData : BYTE* optional -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtssetrenderhint =
  foreign "WTSSetRenderHint"
    ((ptr uint64_t) @-> (ptr void) @-> uint32_t @-> uint32_t @-> (ptr uint8_t) @-> returning int32_t)
(* pRenderHintID : ULONGLONG* in/out -> (ptr uint64_t) *)
(* hwndOwner : HWND -> (ptr void) *)
(* renderHintType : DWORD -> uint32_t *)
(* cbHintDataLength : DWORD -> uint32_t *)
(* pHintData : BYTE* optional -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wtsapi32 (t "WTSAPI32.dll"))
(cffi:use-foreign-library wtsapi32)

(cffi:defcfun ("WTSSetRenderHint" wtsset-render-hint :convention :stdcall) :int32
  (p-render-hint-id :pointer)   ; ULONGLONG* in/out
  (hwnd-owner :pointer)   ; HWND
  (render-hint-type :uint32)   ; DWORD
  (cb-hint-data-length :uint32)   ; DWORD
  (p-hint-data :pointer))   ; BYTE* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSSetRenderHint = Win32::API::More->new('WTSAPI32',
    'int WTSSetRenderHint(LPVOID pRenderHintID, HANDLE hwndOwner, DWORD renderHintType, DWORD cbHintDataLength, LPVOID pHintData)');
# my $ret = $WTSSetRenderHint->Call($pRenderHintID, $hwndOwner, $renderHintType, $cbHintDataLength, $pHintData);
# pRenderHintID : ULONGLONG* in/out -> LPVOID
# hwndOwner : HWND -> HANDLE
# renderHintType : DWORD -> DWORD
# cbHintDataLength : DWORD -> DWORD
# pHintData : BYTE* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。