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

PSFormatForDisplayAlloc

関数
プロパティ値を表示用文字列に整形しバッファを確保する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT PSFormatForDisplayAlloc(
    const PROPERTYKEY* key,
    const PROPVARIANT* propvar,
    PROPDESC_FORMAT_FLAGS pdff,
    LPWSTR* ppszDisplay
);

パラメーター

名前方向
keyPROPERTYKEY*in
propvarPROPVARIANT*in
pdffPROPDESC_FORMAT_FLAGSin
ppszDisplayLPWSTR*out

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT PSFormatForDisplayAlloc(
    const PROPERTYKEY* key,
    const PROPVARIANT* propvar,
    PROPDESC_FORMAT_FLAGS pdff,
    LPWSTR* ppszDisplay
);
[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PSFormatForDisplayAlloc(
    IntPtr key,   // PROPERTYKEY*
    IntPtr propvar,   // PROPVARIANT*
    int pdff,   // PROPDESC_FORMAT_FLAGS
    IntPtr ppszDisplay   // LPWSTR* out
);
<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PSFormatForDisplayAlloc(
    key As IntPtr,   ' PROPERTYKEY*
    propvar As IntPtr,   ' PROPVARIANT*
    pdff As Integer,   ' PROPDESC_FORMAT_FLAGS
    ppszDisplay As IntPtr   ' LPWSTR* out
) As Integer
End Function
' key : PROPERTYKEY*
' propvar : PROPVARIANT*
' pdff : PROPDESC_FORMAT_FLAGS
' ppszDisplay : LPWSTR* out
Declare PtrSafe Function PSFormatForDisplayAlloc Lib "propsys" ( _
    ByVal key As LongPtr, _
    ByVal propvar As LongPtr, _
    ByVal pdff As Long, _
    ByVal ppszDisplay As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PSFormatForDisplayAlloc = ctypes.windll.propsys.PSFormatForDisplayAlloc
PSFormatForDisplayAlloc.restype = ctypes.c_int
PSFormatForDisplayAlloc.argtypes = [
    ctypes.c_void_p,  # key : PROPERTYKEY*
    ctypes.c_void_p,  # propvar : PROPVARIANT*
    ctypes.c_int,  # pdff : PROPDESC_FORMAT_FLAGS
    ctypes.c_void_p,  # ppszDisplay : LPWSTR* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPSFormatForDisplayAlloc = propsys.NewProc("PSFormatForDisplayAlloc")
)

// key (PROPERTYKEY*), propvar (PROPVARIANT*), pdff (PROPDESC_FORMAT_FLAGS), ppszDisplay (LPWSTR* out)
r1, _, err := procPSFormatForDisplayAlloc.Call(
	uintptr(key),
	uintptr(propvar),
	uintptr(pdff),
	uintptr(ppszDisplay),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function PSFormatForDisplayAlloc(
  key: Pointer;   // PROPERTYKEY*
  propvar: Pointer;   // PROPVARIANT*
  pdff: Integer;   // PROPDESC_FORMAT_FLAGS
  ppszDisplay: PPWideChar   // LPWSTR* out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PSFormatForDisplayAlloc';
result := DllCall("PROPSYS\PSFormatForDisplayAlloc"
    , "Ptr", key   ; PROPERTYKEY*
    , "Ptr", propvar   ; PROPVARIANT*
    , "Int", pdff   ; PROPDESC_FORMAT_FLAGS
    , "Ptr", ppszDisplay   ; LPWSTR* out
    , "Int")   ; return: HRESULT
●PSFormatForDisplayAlloc(key, propvar, pdff, ppszDisplay) = DLL("PROPSYS.dll", "int PSFormatForDisplayAlloc(void*, void*, int, void*)")
# 呼び出し: PSFormatForDisplayAlloc(key, propvar, pdff, ppszDisplay)
# key : PROPERTYKEY* -> "void*"
# propvar : PROPVARIANT* -> "void*"
# pdff : PROPDESC_FORMAT_FLAGS -> "int"
# ppszDisplay : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。