Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › SetPropW

SetPropW

関数
ウィンドウのプロパティリストにデータを設定する(Unicode版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL SetPropW(
    HWND hWnd,
    LPCWSTR lpString,
    HANDLE hData   // optional
);

パラメーター

名前方向説明
hWndHWNDinプロパティリストに新しいエントリを受け取るウィンドウへのハンドル。
lpStringLPCWSTRinNULL 終端文字列、または文字列を識別するアトム。このパラメーターがアトムの場合、それは事前に GlobalAddAtom 関数を呼び出して作成したグローバルアトムでなければなりません。アトムは lpString の下位ワードに配置する必要があり、上位ワードはゼロでなければなりません。
hDataHANDLEinoptionalプロパティリストにコピーするデータへのハンドル。このデータハンドルには、アプリケーションにとって有用な任意の値を識別させることができます。

戻り値の型: BOOL

公式ドキュメント

指定したウィンドウのプロパティリストに新しいエントリを追加するか、既存のエントリを変更します。(Unicode)

戻り値

型: BOOL

データハンドルと文字列がプロパティリストに追加された場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

ウィンドウが破棄される前(つまり WM_NCDESTROY メッセージの処理から戻る前)に、アプリケーションはプロパティリストに追加したすべてのエントリを削除する必要があります。エントリの削除には RemoveProp 関数を使用する必要があります。

SetProp は、User Interface Privilege Isolation (UIPI) の制約を受けます。プロセスは、自身と同等以下の整合性レベルを持つプロセスに属するウィンドウに対してのみ、この関数を呼び出すことができます。UIPI がプロパティの変更をブロックした場合、GetLastError は 5 を返します。

例については、ウィンドウプロパティの追加を参照してください。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetProp を定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL SetPropW(
    HWND hWnd,
    LPCWSTR lpString,
    HANDLE hData   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetPropW(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] string lpString,   // LPCWSTR
    IntPtr hData   // HANDLE optional
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetPropW(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String,   ' LPCWSTR
    hData As IntPtr   ' HANDLE optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWnd : HWND
' lpString : LPCWSTR
' hData : HANDLE optional
Declare PtrSafe Function SetPropW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal hData As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetPropW = ctypes.windll.user32.SetPropW
SetPropW.restype = wintypes.BOOL
SetPropW.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPCWSTR,  # lpString : LPCWSTR
    wintypes.HANDLE,  # hData : HANDLE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetPropW = Fiddle::Function.new(
  lib['SetPropW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
    Fiddle::TYPE_VOIDP,  # hData : HANDLE optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn SetPropW(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpString: *const u16,  // LPCWSTR
        hData: *mut core::ffi::c_void  // HANDLE optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetPropW(IntPtr hWnd, [MarshalAs(UnmanagedType.LPWStr)] string lpString, IntPtr hData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetPropW' -Namespace Win32 -PassThru
# $api::SetPropW(hWnd, lpString, hData)
#uselib "USER32.dll"
#func global SetPropW "SetPropW" wptr, wptr, wptr
; SetPropW hWnd, lpString, hData   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; lpString : LPCWSTR -> "wptr"
; hData : HANDLE optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetPropW "SetPropW" sptr, wstr, sptr
; res = SetPropW(hWnd, lpString, hData)
; hWnd : HWND -> "sptr"
; lpString : LPCWSTR -> "wstr"
; hData : HANDLE optional -> "sptr"
; BOOL SetPropW(HWND hWnd, LPCWSTR lpString, HANDLE hData)
#uselib "USER32.dll"
#cfunc global SetPropW "SetPropW" intptr, wstr, intptr
; res = SetPropW(hWnd, lpString, hData)
; hWnd : HWND -> "intptr"
; lpString : LPCWSTR -> "wstr"
; hData : HANDLE optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetPropW = user32.NewProc("SetPropW")
)

// hWnd (HWND), lpString (LPCWSTR), hData (HANDLE optional)
r1, _, err := procSetPropW.Call(
	uintptr(hWnd),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
	uintptr(hData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetPropW(
  hWnd: THandle;   // HWND
  lpString: PWideChar;   // LPCWSTR
  hData: THandle   // HANDLE optional
): BOOL; stdcall;
  external 'USER32.dll' name 'SetPropW';
result := DllCall("USER32\SetPropW"
    , "Ptr", hWnd   ; HWND
    , "WStr", lpString   ; LPCWSTR
    , "Ptr", hData   ; HANDLE optional
    , "Int")   ; return: BOOL
●SetPropW(hWnd, lpString, hData) = DLL("USER32.dll", "bool SetPropW(void*, char*, void*)")
# 呼び出し: SetPropW(hWnd, lpString, hData)
# hWnd : HWND -> "void*"
# lpString : LPCWSTR -> "char*"
# hData : HANDLE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn SetPropW(
    hWnd: ?*anyopaque, // HWND
    lpString: [*c]const u16, // LPCWSTR
    hData: ?*anyopaque // HANDLE optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetPropW(
    hWnd: pointer,  # HWND
    lpString: WideCString,  # LPCWSTR
    hData: pointer  # HANDLE optional
): int32 {.importc: "SetPropW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int SetPropW(
    void* hWnd,   // HWND
    const(wchar)* lpString,   // LPCWSTR
    void* hData   // HANDLE optional
);
ccall((:SetPropW, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Ptr{Cvoid}),
      hWnd, lpString, hData)
# hWnd : HWND -> Ptr{Cvoid}
# lpString : LPCWSTR -> Cwstring
# hData : HANDLE optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetPropW(
    void* hWnd,
    const uint16_t* lpString,
    void* hData);
]]
local user32 = ffi.load("user32")
-- user32.SetPropW(hWnd, lpString, hData)
-- hWnd : HWND
-- lpString : LPCWSTR
-- hData : HANDLE optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetPropW = lib.func('__stdcall', 'SetPropW', 'int32_t', ['void *', 'str16', 'void *']);
// SetPropW(hWnd, lpString, hData)
// hWnd : HWND -> 'void *'
// lpString : LPCWSTR -> 'str16'
// hData : HANDLE optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SetPropW: { parameters: ["pointer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.SetPropW(hWnd, lpString, hData)
// hWnd : HWND -> "pointer"
// lpString : LPCWSTR -> "buffer"
// hData : HANDLE optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetPropW(
    void* hWnd,
    const uint16_t* lpString,
    void* hData);
C, "USER32.dll");
// $ffi->SetPropW(hWnd, lpString, hData);
// hWnd : HWND
// lpString : LPCWSTR
// hData : HANDLE 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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SetPropW(
        Pointer hWnd,   // HWND
        WString lpString,   // LPCWSTR
        Pointer hData   // HANDLE optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun SetPropW = SetPropW(
    hWnd : Void*,   # HWND
    lpString : UInt16*,   # LPCWSTR
    hData : Void*   # HANDLE optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetPropWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>);
typedef SetPropWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>);
final SetPropW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetPropWNative, SetPropWDart>('SetPropW');
// hWnd : HWND -> Pointer<Void>
// lpString : LPCWSTR -> Pointer<Utf16>
// hData : HANDLE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetPropW(
  hWnd: THandle;   // HWND
  lpString: PWideChar;   // LPCWSTR
  hData: THandle   // HANDLE optional
): BOOL; stdcall;
  external 'USER32.dll' name 'SetPropW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetPropW"
  c_SetPropW :: Ptr () -> CWString -> Ptr () -> IO CInt
-- hWnd : HWND -> Ptr ()
-- lpString : LPCWSTR -> CWString
-- hData : HANDLE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setpropw =
  foreign "SetPropW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* lpString : LPCWSTR -> (ptr uint16_t) *)
(* hData : HANDLE optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetPropW" set-prop-w :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (lp-string (:string :encoding :utf-16le))   ; LPCWSTR
  (h-data :pointer))   ; HANDLE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetPropW = Win32::API::More->new('USER32',
    'BOOL SetPropW(HANDLE hWnd, LPCWSTR lpString, HANDLE hData)');
# my $ret = $SetPropW->Call($hWnd, $lpString, $hData);
# hWnd : HWND -> HANDLE
# lpString : LPCWSTR -> LPCWSTR
# hData : HANDLE optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目