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

PSStringFromPropertyKey

関数
プロパティキーを文字列形式に変換する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PSStringFromPropertyKey(
    const PROPERTYKEY* pkey,
    LPWSTR psz,
    DWORD cch
);

パラメーター

名前方向説明
pkeyPROPERTYKEY*in文字列化する対象のプロパティキーへのポインタ。
pszLPWSTRout生成された文字列(GUID形式)を受け取る出力バッファ。
cchDWORDinpszバッファのサイズ(文字数)。PKEYSTR_MAX以上が望ましい。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT PSStringFromPropertyKey(
    const PROPERTYKEY* pkey,
    LPWSTR psz,
    DWORD cch
);
[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PSStringFromPropertyKey(
    IntPtr pkey,   // PROPERTYKEY*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder psz,   // LPWSTR out
    uint cch   // DWORD
);
<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PSStringFromPropertyKey(
    pkey As IntPtr,   ' PROPERTYKEY*
    <MarshalAs(UnmanagedType.LPWStr)> psz As System.Text.StringBuilder,   ' LPWSTR out
    cch As UInteger   ' DWORD
) As Integer
End Function
' pkey : PROPERTYKEY*
' psz : LPWSTR out
' cch : DWORD
Declare PtrSafe Function PSStringFromPropertyKey Lib "propsys" ( _
    ByVal pkey As LongPtr, _
    ByVal psz As LongPtr, _
    ByVal cch As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PSStringFromPropertyKey = ctypes.windll.propsys.PSStringFromPropertyKey
PSStringFromPropertyKey.restype = ctypes.c_int
PSStringFromPropertyKey.argtypes = [
    ctypes.c_void_p,  # pkey : PROPERTYKEY*
    wintypes.LPWSTR,  # psz : LPWSTR out
    wintypes.DWORD,  # cch : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPSStringFromPropertyKey = propsys.NewProc("PSStringFromPropertyKey")
)

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

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

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

foreign import stdcall safe "PSStringFromPropertyKey"
  c_PSStringFromPropertyKey :: Ptr () -> CWString -> Word32 -> IO Int32
-- pkey : PROPERTYKEY* -> Ptr ()
-- psz : LPWSTR out -> CWString
-- cch : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let psstringfrompropertykey =
  foreign "PSStringFromPropertyKey"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pkey : PROPERTYKEY* -> (ptr void) *)
(* psz : LPWSTR out -> (ptr uint16_t) *)
(* cch : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("PSStringFromPropertyKey" psstring-from-property-key :convention :stdcall) :int32
  (pkey :pointer)   ; PROPERTYKEY*
  (psz :pointer)   ; LPWSTR out
  (cch :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PSStringFromPropertyKey = Win32::API::More->new('PROPSYS',
    'int PSStringFromPropertyKey(LPVOID pkey, LPWSTR psz, DWORD cch)');
# my $ret = $PSStringFromPropertyKey->Call($pkey, $psz, $cch);
# pkey : PROPERTYKEY* -> LPVOID
# psz : LPWSTR out -> LPWSTR
# cch : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型