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

PSFormatForDisplay

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

シグネチャ

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

HRESULT PSFormatForDisplay(
    const PROPERTYKEY* propkey,
    const PROPVARIANT* propvar,
    PROPDESC_FORMAT_FLAGS pdfFlags,
    LPWSTR pwszText,
    DWORD cchText
);

パラメーター

名前方向
propkeyPROPERTYKEY*in
propvarPROPVARIANT*in
pdfFlagsPROPDESC_FORMAT_FLAGSin
pwszTextLPWSTRout
cchTextDWORDin

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

PSFormatForDisplay = ctypes.windll.propsys.PSFormatForDisplay
PSFormatForDisplay.restype = ctypes.c_int
PSFormatForDisplay.argtypes = [
    ctypes.c_void_p,  # propkey : PROPERTYKEY*
    ctypes.c_void_p,  # propvar : PROPVARIANT*
    ctypes.c_int,  # pdfFlags : PROPDESC_FORMAT_FLAGS
    wintypes.LPWSTR,  # pwszText : LPWSTR out
    wintypes.DWORD,  # cchText : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPSFormatForDisplay = propsys.NewProc("PSFormatForDisplay")
)

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