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

SetPropA

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL SetPropA(
    HWND hWnd,
    LPCSTR lpString,
    HANDLE hData   // optional
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

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

解説(Remarks)

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

SetProp は、ユーザー インターフェイス特権分離(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  (ANSI / -A)
#include <windows.h>

BOOL SetPropA(
    HWND hWnd,
    LPCSTR lpString,
    HANDLE hData   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetPropA(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPStr)] string lpString,   // LPCSTR
    IntPtr hData   // HANDLE optional
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetPropA(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPStr)> lpString As String,   ' LPCSTR
    hData As IntPtr   ' HANDLE optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWnd : HWND
' lpString : LPCSTR
' hData : HANDLE optional
Declare PtrSafe Function SetPropA Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpString As String, _
    ByVal hData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetPropA = ctypes.windll.user32.SetPropA
SetPropA.restype = wintypes.BOOL
SetPropA.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPCSTR,  # lpString : LPCSTR
    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')
SetPropA = Fiddle::Function.new(
  lib['SetPropA'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpString : LPCSTR
    Fiddle::TYPE_VOIDP,  # hData : HANDLE optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn SetPropA(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpString: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool SetPropA(IntPtr hWnd, [MarshalAs(UnmanagedType.LPStr)] string lpString, IntPtr hData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetPropA' -Namespace Win32 -PassThru
# $api::SetPropA(hWnd, lpString, hData)
#uselib "USER32.dll"
#func global SetPropA "SetPropA" sptr, sptr, sptr
; SetPropA hWnd, lpString, hData   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; lpString : LPCSTR -> "sptr"
; hData : HANDLE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetPropA "SetPropA" sptr, str, sptr
; res = SetPropA(hWnd, lpString, hData)
; hWnd : HWND -> "sptr"
; lpString : LPCSTR -> "str"
; hData : HANDLE optional -> "sptr"
; BOOL SetPropA(HWND hWnd, LPCSTR lpString, HANDLE hData)
#uselib "USER32.dll"
#cfunc global SetPropA "SetPropA" intptr, str, intptr
; res = SetPropA(hWnd, lpString, hData)
; hWnd : HWND -> "intptr"
; lpString : LPCSTR -> "str"
; hData : HANDLE optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetPropA = user32.NewProc("SetPropA")
)

// hWnd (HWND), lpString (LPCSTR), hData (HANDLE optional)
r1, _, err := procSetPropA.Call(
	uintptr(hWnd),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpString))),
	uintptr(hData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetPropA(
  hWnd: THandle;   // HWND
  lpString: PAnsiChar;   // LPCSTR
  hData: THandle   // HANDLE optional
): BOOL; stdcall;
  external 'USER32.dll' name 'SetPropA';
result := DllCall("USER32\SetPropA"
    , "Ptr", hWnd   ; HWND
    , "AStr", lpString   ; LPCSTR
    , "Ptr", hData   ; HANDLE optional
    , "Int")   ; return: BOOL
●SetPropA(hWnd, lpString, hData) = DLL("USER32.dll", "bool SetPropA(void*, char*, void*)")
# 呼び出し: SetPropA(hWnd, lpString, hData)
# hWnd : HWND -> "void*"
# lpString : LPCSTR -> "char*"
# hData : HANDLE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn SetPropA(
    hWnd: ?*anyopaque, // HWND
    lpString: [*c]const u8, // LPCSTR
    hData: ?*anyopaque // HANDLE optional
) callconv(std.os.windows.WINAPI) i32;
proc SetPropA(
    hWnd: pointer,  # HWND
    lpString: cstring,  # LPCSTR
    hData: pointer  # HANDLE optional
): int32 {.importc: "SetPropA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int SetPropA(
    void* hWnd,   // HWND
    const(char)* lpString,   // LPCSTR
    void* hData   // HANDLE optional
);
ccall((:SetPropA, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Ptr{Cvoid}),
      hWnd, lpString, hData)
# hWnd : HWND -> Ptr{Cvoid}
# lpString : LPCSTR -> Cstring
# hData : HANDLE optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetPropA(
    void* hWnd,
    const char* lpString,
    void* hData);
]]
local user32 = ffi.load("user32")
-- user32.SetPropA(hWnd, lpString, hData)
-- hWnd : HWND
-- lpString : LPCSTR
-- hData : HANDLE optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetPropA = lib.func('__stdcall', 'SetPropA', 'int32_t', ['void *', 'str', 'void *']);
// SetPropA(hWnd, lpString, hData)
// hWnd : HWND -> 'void *'
// lpString : LPCSTR -> 'str'
// hData : HANDLE optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SetPropA: { parameters: ["pointer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.SetPropA(hWnd, lpString, hData)
// hWnd : HWND -> "pointer"
// lpString : LPCSTR -> "buffer"
// hData : HANDLE optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetPropA(
    void* hWnd,
    const char* lpString,
    void* hData);
C, "USER32.dll");
// $ffi->SetPropA(hWnd, lpString, hData);
// hWnd : HWND
// lpString : LPCSTR
// 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.ASCII_OPTIONS);
    boolean SetPropA(
        Pointer hWnd,   // HWND
        String lpString,   // LPCSTR
        Pointer hData   // HANDLE optional
    );
}
@[Link("user32")]
lib LibUSER32
  fun SetPropA = SetPropA(
    hWnd : Void*,   # HWND
    lpString : UInt8*,   # LPCSTR
    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 SetPropANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>);
typedef SetPropADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>);
final SetPropA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetPropANative, SetPropADart>('SetPropA');
// hWnd : HWND -> Pointer<Void>
// lpString : LPCSTR -> Pointer<Utf8>
// hData : HANDLE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetPropA(
  hWnd: THandle;   // HWND
  lpString: PAnsiChar;   // LPCSTR
  hData: THandle   // HANDLE optional
): BOOL; stdcall;
  external 'USER32.dll' name 'SetPropA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setpropa =
  foreign "SetPropA"
    ((ptr void) @-> string @-> (ptr void) @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* lpString : LPCSTR -> string *)
(* 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 ("SetPropA" set-prop-a :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (lp-string :string)   ; LPCSTR
  (h-data :pointer))   ; HANDLE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetPropA = Win32::API::More->new('USER32',
    'BOOL SetPropA(HANDLE hWnd, LPCSTR lpString, HANDLE hData)');
# my $ret = $SetPropA->Call($hWnd, $lpString, $hData);
# hWnd : HWND -> HANDLE
# lpString : LPCSTR -> LPCSTR
# hData : HANDLE optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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