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

PSGetPropertyKeyFromName

関数
正規名からプロパティキーを取得する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PSGetPropertyKeyFromName(
    LPCWSTR pszName,
    PROPERTYKEY* ppropkey
);

パラメーター

名前方向説明
pszNameLPCWSTRinプロパティキーを求めるプロパティのカノニカル名。
ppropkeyPROPERTYKEY*out求めたプロパティキーを受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT PSGetPropertyKeyFromName(
    LPCWSTR pszName,
    PROPERTYKEY* ppropkey
);
[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PSGetPropertyKeyFromName(
    [MarshalAs(UnmanagedType.LPWStr)] string pszName,   // LPCWSTR
    IntPtr ppropkey   // PROPERTYKEY* out
);
<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PSGetPropertyKeyFromName(
    <MarshalAs(UnmanagedType.LPWStr)> pszName As String,   ' LPCWSTR
    ppropkey As IntPtr   ' PROPERTYKEY* out
) As Integer
End Function
' pszName : LPCWSTR
' ppropkey : PROPERTYKEY* out
Declare PtrSafe Function PSGetPropertyKeyFromName Lib "propsys" ( _
    ByVal pszName As LongPtr, _
    ByVal ppropkey As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PSGetPropertyKeyFromName = ctypes.windll.propsys.PSGetPropertyKeyFromName
PSGetPropertyKeyFromName.restype = ctypes.c_int
PSGetPropertyKeyFromName.argtypes = [
    wintypes.LPCWSTR,  # pszName : LPCWSTR
    ctypes.c_void_p,  # ppropkey : PROPERTYKEY* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPSGetPropertyKeyFromName = propsys.NewProc("PSGetPropertyKeyFromName")
)

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

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

typedef PSGetPropertyKeyFromNameNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef PSGetPropertyKeyFromNameDart = int Function(Pointer<Utf16>, Pointer<Void>);
final PSGetPropertyKeyFromName = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<PSGetPropertyKeyFromNameNative, PSGetPropertyKeyFromNameDart>('PSGetPropertyKeyFromName');
// pszName : LPCWSTR -> Pointer<Utf16>
// ppropkey : PROPERTYKEY* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PSGetPropertyKeyFromName(
  pszName: PWideChar;   // LPCWSTR
  ppropkey: Pointer   // PROPERTYKEY* out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PSGetPropertyKeyFromName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PSGetPropertyKeyFromName"
  c_PSGetPropertyKeyFromName :: CWString -> Ptr () -> IO Int32
-- pszName : LPCWSTR -> CWString
-- ppropkey : PROPERTYKEY* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let psgetpropertykeyfromname =
  foreign "PSGetPropertyKeyFromName"
    ((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* pszName : LPCWSTR -> (ptr uint16_t) *)
(* ppropkey : PROPERTYKEY* 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 ("PSGetPropertyKeyFromName" psget-property-key-from-name :convention :stdcall) :int32
  (psz-name (:string :encoding :utf-16le))   ; LPCWSTR
  (ppropkey :pointer))   ; PROPERTYKEY* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PSGetPropertyKeyFromName = Win32::API::More->new('PROPSYS',
    'int PSGetPropertyKeyFromName(LPCWSTR pszName, LPVOID ppropkey)');
# my $ret = $PSGetPropertyKeyFromName->Call($pszName, $ppropkey);
# pszName : LPCWSTR -> LPCWSTR
# ppropkey : PROPERTYKEY* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型