Win32 API 日本語リファレンス
ホームUI.Shell.PropertiesSystem › PSGetPropertyValue

PSGetPropertyValue

関数
プロパティストアから指定プロパティ値を取得する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PSGetPropertyValue(
    IPropertyStore* pps,
    IPropertyDescription* ppd,
    PROPVARIANT* ppropvar
);

パラメーター

名前方向説明
ppsIPropertyStore*in値を取得するプロパティストア。
ppdIPropertyDescription*in取得対象プロパティの記述子。
ppropvarPROPVARIANT*out取得した値を受け取るPROPVARIANT出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT PSGetPropertyValue(
    IPropertyStore* pps,
    IPropertyDescription* ppd,
    PROPVARIANT* ppropvar
);
[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PSGetPropertyValue(
    IntPtr pps,   // IPropertyStore*
    IntPtr ppd,   // IPropertyDescription*
    IntPtr ppropvar   // PROPVARIANT* out
);
<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PSGetPropertyValue(
    pps As IntPtr,   ' IPropertyStore*
    ppd As IntPtr,   ' IPropertyDescription*
    ppropvar As IntPtr   ' PROPVARIANT* out
) As Integer
End Function
' pps : IPropertyStore*
' ppd : IPropertyDescription*
' ppropvar : PROPVARIANT* out
Declare PtrSafe Function PSGetPropertyValue Lib "propsys" ( _
    ByVal pps As LongPtr, _
    ByVal ppd As LongPtr, _
    ByVal ppropvar As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PSGetPropertyValue = ctypes.windll.propsys.PSGetPropertyValue
PSGetPropertyValue.restype = ctypes.c_int
PSGetPropertyValue.argtypes = [
    ctypes.c_void_p,  # pps : IPropertyStore*
    ctypes.c_void_p,  # ppd : IPropertyDescription*
    ctypes.c_void_p,  # ppropvar : PROPVARIANT* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
PSGetPropertyValue = Fiddle::Function.new(
  lib['PSGetPropertyValue'],
  [
    Fiddle::TYPE_VOIDP,  # pps : IPropertyStore*
    Fiddle::TYPE_VOIDP,  # ppd : IPropertyDescription*
    Fiddle::TYPE_VOIDP,  # ppropvar : PROPVARIANT* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "propsys")]
extern "system" {
    fn PSGetPropertyValue(
        pps: *mut core::ffi::c_void,  // IPropertyStore*
        ppd: *mut core::ffi::c_void,  // IPropertyDescription*
        ppropvar: *mut PROPVARIANT  // PROPVARIANT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("PROPSYS.dll")]
public static extern int PSGetPropertyValue(IntPtr pps, IntPtr ppd, IntPtr ppropvar);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PROPSYS_PSGetPropertyValue' -Namespace Win32 -PassThru
# $api::PSGetPropertyValue(pps, ppd, ppropvar)
#uselib "PROPSYS.dll"
#func global PSGetPropertyValue "PSGetPropertyValue" sptr, sptr, sptr
; PSGetPropertyValue pps, ppd, varptr(ppropvar)   ; 戻り値は stat
; pps : IPropertyStore* -> "sptr"
; ppd : IPropertyDescription* -> "sptr"
; ppropvar : PROPVARIANT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "PROPSYS.dll"
#cfunc global PSGetPropertyValue "PSGetPropertyValue" sptr, sptr, var
; res = PSGetPropertyValue(pps, ppd, ppropvar)
; pps : IPropertyStore* -> "sptr"
; ppd : IPropertyDescription* -> "sptr"
; ppropvar : PROPVARIANT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT PSGetPropertyValue(IPropertyStore* pps, IPropertyDescription* ppd, PROPVARIANT* ppropvar)
#uselib "PROPSYS.dll"
#cfunc global PSGetPropertyValue "PSGetPropertyValue" intptr, intptr, var
; res = PSGetPropertyValue(pps, ppd, ppropvar)
; pps : IPropertyStore* -> "intptr"
; ppd : IPropertyDescription* -> "intptr"
; ppropvar : PROPVARIANT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPSGetPropertyValue = propsys.NewProc("PSGetPropertyValue")
)

// pps (IPropertyStore*), ppd (IPropertyDescription*), ppropvar (PROPVARIANT* out)
r1, _, err := procPSGetPropertyValue.Call(
	uintptr(pps),
	uintptr(ppd),
	uintptr(ppropvar),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function PSGetPropertyValue(
  pps: Pointer;   // IPropertyStore*
  ppd: Pointer;   // IPropertyDescription*
  ppropvar: Pointer   // PROPVARIANT* out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PSGetPropertyValue';
result := DllCall("PROPSYS\PSGetPropertyValue"
    , "Ptr", pps   ; IPropertyStore*
    , "Ptr", ppd   ; IPropertyDescription*
    , "Ptr", ppropvar   ; PROPVARIANT* out
    , "Int")   ; return: HRESULT
●PSGetPropertyValue(pps, ppd, ppropvar) = DLL("PROPSYS.dll", "int PSGetPropertyValue(void*, void*, void*)")
# 呼び出し: PSGetPropertyValue(pps, ppd, ppropvar)
# pps : IPropertyStore* -> "void*"
# ppd : IPropertyDescription* -> "void*"
# ppropvar : PROPVARIANT* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "propsys" fn PSGetPropertyValue(
    pps: ?*anyopaque, // IPropertyStore*
    ppd: ?*anyopaque, // IPropertyDescription*
    ppropvar: [*c]PROPVARIANT // PROPVARIANT* out
) callconv(std.os.windows.WINAPI) i32;
proc PSGetPropertyValue(
    pps: pointer,  # IPropertyStore*
    ppd: pointer,  # IPropertyDescription*
    ppropvar: ptr PROPVARIANT  # PROPVARIANT* out
): int32 {.importc: "PSGetPropertyValue", stdcall, dynlib: "PROPSYS.dll".}
pragma(lib, "propsys");
extern(Windows)
int PSGetPropertyValue(
    void* pps,   // IPropertyStore*
    void* ppd,   // IPropertyDescription*
    PROPVARIANT* ppropvar   // PROPVARIANT* out
);
ccall((:PSGetPropertyValue, "PROPSYS.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{PROPVARIANT}),
      pps, ppd, ppropvar)
# pps : IPropertyStore* -> Ptr{Cvoid}
# ppd : IPropertyDescription* -> Ptr{Cvoid}
# ppropvar : PROPVARIANT* out -> Ptr{PROPVARIANT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t PSGetPropertyValue(
    void* pps,
    void* ppd,
    void* ppropvar);
]]
local propsys = ffi.load("propsys")
-- propsys.PSGetPropertyValue(pps, ppd, ppropvar)
-- pps : IPropertyStore*
-- ppd : IPropertyDescription*
-- ppropvar : PROPVARIANT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('PROPSYS.dll');
const PSGetPropertyValue = lib.func('__stdcall', 'PSGetPropertyValue', 'int32_t', ['void *', 'void *', 'void *']);
// PSGetPropertyValue(pps, ppd, ppropvar)
// pps : IPropertyStore* -> 'void *'
// ppd : IPropertyDescription* -> 'void *'
// ppropvar : PROPVARIANT* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("PROPSYS.dll", {
  PSGetPropertyValue: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.PSGetPropertyValue(pps, ppd, ppropvar)
// pps : IPropertyStore* -> "pointer"
// ppd : IPropertyDescription* -> "pointer"
// ppropvar : PROPVARIANT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PSGetPropertyValue(
    void* pps,
    void* ppd,
    void* ppropvar);
C, "PROPSYS.dll");
// $ffi->PSGetPropertyValue(pps, ppd, ppropvar);
// pps : IPropertyStore*
// ppd : IPropertyDescription*
// ppropvar : PROPVARIANT* out
// 構造体/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 Propsys extends StdCallLibrary {
    Propsys INSTANCE = Native.load("propsys", Propsys.class);
    int PSGetPropertyValue(
        Pointer pps,   // IPropertyStore*
        Pointer ppd,   // IPropertyDescription*
        Pointer ppropvar   // PROPVARIANT* out
    );
}
@[Link("propsys")]
lib LibPROPSYS
  fun PSGetPropertyValue = PSGetPropertyValue(
    pps : Void*,   # IPropertyStore*
    ppd : Void*,   # IPropertyDescription*
    ppropvar : PROPVARIANT*   # PROPVARIANT* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PSGetPropertyValueNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef PSGetPropertyValueDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final PSGetPropertyValue = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<PSGetPropertyValueNative, PSGetPropertyValueDart>('PSGetPropertyValue');
// pps : IPropertyStore* -> Pointer<Void>
// ppd : IPropertyDescription* -> Pointer<Void>
// ppropvar : PROPVARIANT* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PSGetPropertyValue(
  pps: Pointer;   // IPropertyStore*
  ppd: Pointer;   // IPropertyDescription*
  ppropvar: Pointer   // PROPVARIANT* out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PSGetPropertyValue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PSGetPropertyValue"
  c_PSGetPropertyValue :: Ptr () -> Ptr () -> Ptr () -> IO Int32
-- pps : IPropertyStore* -> Ptr ()
-- ppd : IPropertyDescription* -> Ptr ()
-- ppropvar : PROPVARIANT* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let psgetpropertyvalue =
  foreign "PSGetPropertyValue"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pps : IPropertyStore* -> (ptr void) *)
(* ppd : IPropertyDescription* -> (ptr void) *)
(* ppropvar : PROPVARIANT* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("PSGetPropertyValue" psget-property-value :convention :stdcall) :int32
  (pps :pointer)   ; IPropertyStore*
  (ppd :pointer)   ; IPropertyDescription*
  (ppropvar :pointer))   ; PROPVARIANT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PSGetPropertyValue = Win32::API::More->new('PROPSYS',
    'int PSGetPropertyValue(LPVOID pps, LPVOID ppd, LPVOID ppropvar)');
# my $ret = $PSGetPropertyValue->Call($pps, $ppd, $ppropvar);
# pps : IPropertyStore* -> LPVOID
# ppd : IPropertyDescription* -> LPVOID
# ppropvar : PROPVARIANT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型