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

GetPropA

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

シグネチャ

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

HANDLE GetPropA(
    HWND hWnd,
    LPCSTR lpString
);

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

指定したウィンドウのプロパティリストからデータハンドルを取得します。文字列により取得するハンドルを識別します。この文字列とハンドルは、以前に SetProp 関数を呼び出してプロパティリストに追加されている必要があります。(ANSI)

戻り値

型: HANDLE

プロパティリストに文字列が含まれている場合、戻り値は関連付けられたデータハンドルです。それ以外の場合、戻り値は NULL です。

解説(Remarks)

メモ

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

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

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

GetPropA = ctypes.windll.user32.GetPropA
GetPropA.restype = ctypes.c_void_p
GetPropA.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPCSTR,  # lpString : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetPropA = user32.NewProc("GetPropA")
)

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

extern "user32" fn GetPropA(
    hWnd: ?*anyopaque, // HWND
    lpString: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc GetPropA(
    hWnd: pointer,  # HWND
    lpString: cstring  # LPCSTR
): pointer {.importc: "GetPropA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
void* GetPropA(
    void* hWnd,   // HWND
    const(char)* lpString   // LPCSTR
);
ccall((:GetPropA, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cstring),
      hWnd, lpString)
# hWnd : HWND -> Ptr{Cvoid}
# lpString : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* GetPropA(
    void* hWnd,
    const char* lpString);
]]
local user32 = ffi.load("user32")
-- user32.GetPropA(hWnd, lpString)
-- hWnd : HWND
-- lpString : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetPropA = lib.func('__stdcall', 'GetPropA', 'void *', ['void *', 'str']);
// GetPropA(hWnd, lpString)
// hWnd : HWND -> 'void *'
// lpString : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetPropA: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.GetPropA(hWnd, lpString)
// hWnd : HWND -> "pointer"
// lpString : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* GetPropA(
    void* hWnd,
    const char* lpString);
C, "USER32.dll");
// $ffi->GetPropA(hWnd, lpString);
// hWnd : HWND
// lpString : LPCSTR
// 構造体/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);
    Pointer GetPropA(
        Pointer hWnd,   // HWND
        String lpString   // LPCSTR
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetPropA = GetPropA(
    hWnd : Void*,   # HWND
    lpString : UInt8*   # LPCSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("GetPropA" get-prop-a :convention :stdcall) :pointer
  (h-wnd :pointer)   ; HWND
  (lp-string :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetPropA = Win32::API::More->new('USER32',
    'HANDLE GetPropA(HANDLE hWnd, LPCSTR lpString)');
# my $ret = $GetPropA->Call($hWnd, $lpString);
# hWnd : HWND -> HANDLE
# lpString : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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