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

RemovePropW

関数
ウィンドウのプロパティリストから項目を削除する(Unicode版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HANDLE RemovePropW(
    HWND hWnd,
    LPCWSTR lpString
);

パラメーター

名前方向説明
hWndHWNDinプロパティリストを変更するウィンドウへのハンドルです。
lpStringLPCWSTRinNULL で終わる文字列、または文字列を識別するアトムです。このパラメーターがアトムである場合、それは GlobalAddAtom 関数を使用して作成されたものでなければなりません。アトムは 16 ビットの値で、lpString の下位ワードに配置する必要があります。上位ワードはゼロでなければなりません。

戻り値の型: HANDLE

公式ドキュメント

指定したウィンドウのプロパティリストからエントリを削除します。削除するエントリは、指定した文字列によって識別されます。(Unicode)

戻り値

型: HANDLE

戻り値は、指定したデータを識別します。指定したプロパティリスト内でデータが見つからない場合、戻り値は NULL になります。

解説(Remarks)

戻り値は、SetProp に渡された hData の値であり、これはアプリケーション定義の値です。なお、この関数はデータとウィンドウの関連付けを破棄するだけです。必要に応じて、アプリケーションはプロパティリストから削除したエントリに関連付けられたデータハンドルを解放しなければなりません。アプリケーションは、自身が追加したプロパティのみを削除できます。他のアプリケーションやシステム自体が追加したプロパティを削除してはなりません。

RemoveProp 関数は、アプリケーションがハンドルに関連付けられたデータを解放できるように、文字列に関連付けられたデータハンドルを返します。

Windows Vista 以降、RemoveProp はユーザーインターフェイス特権分離 (UIPI: User Interface Privilege Isolation) の制限を受けます。プロセスは、自身と同等以下の整合性レベルを持つプロセスに属するウィンドウに対してのみ、この関数を呼び出すことができます。UIPI によってプロパティの変更がブロックされた場合、GetLastError5 を返します。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

HANDLE RemovePropW(
    HWND hWnd,
    LPCWSTR lpString
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr RemovePropW(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] string lpString   // LPCWSTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RemovePropW(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String   ' LPCWSTR
) As IntPtr
End Function
' hWnd : HWND
' lpString : LPCWSTR
Declare PtrSafe Function RemovePropW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpString As LongPtr) As LongPtr
' 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

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

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procRemovePropW = user32.NewProc("RemovePropW")
)

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

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

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

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

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

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

関連項目

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