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整形元のプロパティ値を保持するPROPVARIANT。
pdfFlagsPROPDESC_FORMAT_FLAGSin表示整形の動作を制御するPROPDESC_FORMAT_FLAGS。
pwszTextLPWSTRout整形した表示文字列を受け取る出力バッファ。
cchTextDWORDinpwszTextバッファのサイズ(文字数)。終端NULを含む。

戻り値の型: 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)。
const std = @import("std");

extern "propsys" fn PSFormatForDisplay(
    propkey: [*c]PROPERTYKEY, // PROPERTYKEY*
    propvar: [*c]PROPVARIANT, // PROPVARIANT*
    pdfFlags: i32, // PROPDESC_FORMAT_FLAGS
    pwszText: [*c]u16, // LPWSTR out
    cchText: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc PSFormatForDisplay(
    propkey: ptr PROPERTYKEY,  # PROPERTYKEY*
    propvar: ptr PROPVARIANT,  # PROPVARIANT*
    pdfFlags: int32,  # PROPDESC_FORMAT_FLAGS
    pwszText: ptr uint16,  # LPWSTR out
    cchText: uint32  # DWORD
): int32 {.importc: "PSFormatForDisplay", stdcall, dynlib: "PROPSYS.dll".}
pragma(lib, "propsys");
extern(Windows)
int PSFormatForDisplay(
    PROPERTYKEY* propkey,   // PROPERTYKEY*
    PROPVARIANT* propvar,   // PROPVARIANT*
    int pdfFlags,   // PROPDESC_FORMAT_FLAGS
    wchar* pwszText,   // LPWSTR out
    uint cchText   // DWORD
);
ccall((:PSFormatForDisplay, "PROPSYS.dll"), stdcall, Int32,
      (Ptr{PROPERTYKEY}, Ptr{PROPVARIANT}, Int32, Ptr{UInt16}, UInt32),
      propkey, propvar, pdfFlags, pwszText, cchText)
# propkey : PROPERTYKEY* -> Ptr{PROPERTYKEY}
# propvar : PROPVARIANT* -> Ptr{PROPVARIANT}
# pdfFlags : PROPDESC_FORMAT_FLAGS -> Int32
# pwszText : LPWSTR out -> Ptr{UInt16}
# cchText : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t PSFormatForDisplay(
    void* propkey,
    void* propvar,
    int32_t pdfFlags,
    uint16_t* pwszText,
    uint32_t cchText);
]]
local propsys = ffi.load("propsys")
-- propsys.PSFormatForDisplay(propkey, propvar, pdfFlags, pwszText, cchText)
-- propkey : PROPERTYKEY*
-- propvar : PROPVARIANT*
-- pdfFlags : PROPDESC_FORMAT_FLAGS
-- pwszText : LPWSTR out
-- cchText : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('PROPSYS.dll');
const PSFormatForDisplay = lib.func('__stdcall', 'PSFormatForDisplay', 'int32_t', ['void *', 'void *', 'int32_t', 'uint16_t *', 'uint32_t']);
// PSFormatForDisplay(propkey, propvar, pdfFlags, pwszText, cchText)
// propkey : PROPERTYKEY* -> 'void *'
// propvar : PROPVARIANT* -> 'void *'
// pdfFlags : PROPDESC_FORMAT_FLAGS -> 'int32_t'
// pwszText : LPWSTR out -> 'uint16_t *'
// cchText : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("PROPSYS.dll", {
  PSFormatForDisplay: { parameters: ["pointer", "pointer", "i32", "buffer", "u32"], result: "i32" },
});
// lib.symbols.PSFormatForDisplay(propkey, propvar, pdfFlags, pwszText, cchText)
// propkey : PROPERTYKEY* -> "pointer"
// propvar : PROPVARIANT* -> "pointer"
// pdfFlags : PROPDESC_FORMAT_FLAGS -> "i32"
// pwszText : LPWSTR out -> "buffer"
// cchText : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PSFormatForDisplay(
    void* propkey,
    void* propvar,
    int32_t pdfFlags,
    uint16_t* pwszText,
    uint32_t cchText);
C, "PROPSYS.dll");
// $ffi->PSFormatForDisplay(propkey, propvar, pdfFlags, pwszText, cchText);
// propkey : PROPERTYKEY*
// propvar : PROPVARIANT*
// pdfFlags : PROPDESC_FORMAT_FLAGS
// pwszText : LPWSTR out
// cchText : 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 PSFormatForDisplay(
        Pointer propkey,   // PROPERTYKEY*
        Pointer propvar,   // PROPVARIANT*
        int pdfFlags,   // PROPDESC_FORMAT_FLAGS
        char[] pwszText,   // LPWSTR out
        int cchText   // DWORD
    );
}
@[Link("propsys")]
lib LibPROPSYS
  fun PSFormatForDisplay = PSFormatForDisplay(
    propkey : PROPERTYKEY*,   # PROPERTYKEY*
    propvar : PROPVARIANT*,   # PROPVARIANT*
    pdfFlags : Int32,   # PROPDESC_FORMAT_FLAGS
    pwszText : UInt16*,   # LPWSTR out
    cchText : 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 PSFormatForDisplayNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32, Pointer<Utf16>, Uint32);
typedef PSFormatForDisplayDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Utf16>, int);
final PSFormatForDisplay = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<PSFormatForDisplayNative, PSFormatForDisplayDart>('PSFormatForDisplay');
// propkey : PROPERTYKEY* -> Pointer<Void>
// propvar : PROPVARIANT* -> Pointer<Void>
// pdfFlags : PROPDESC_FORMAT_FLAGS -> Int32
// pwszText : LPWSTR out -> Pointer<Utf16>
// cchText : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PSFormatForDisplay"
  c_PSFormatForDisplay :: Ptr () -> Ptr () -> Int32 -> CWString -> Word32 -> IO Int32
-- propkey : PROPERTYKEY* -> Ptr ()
-- propvar : PROPVARIANT* -> Ptr ()
-- pdfFlags : PROPDESC_FORMAT_FLAGS -> Int32
-- pwszText : LPWSTR out -> CWString
-- cchText : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let psformatfordisplay =
  foreign "PSFormatForDisplay"
    ((ptr void) @-> (ptr void) @-> int32_t @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* propkey : PROPERTYKEY* -> (ptr void) *)
(* propvar : PROPVARIANT* -> (ptr void) *)
(* pdfFlags : PROPDESC_FORMAT_FLAGS -> int32_t *)
(* pwszText : LPWSTR out -> (ptr uint16_t) *)
(* cchText : 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 ("PSFormatForDisplay" psformat-for-display :convention :stdcall) :int32
  (propkey :pointer)   ; PROPERTYKEY*
  (propvar :pointer)   ; PROPVARIANT*
  (pdf-flags :int32)   ; PROPDESC_FORMAT_FLAGS
  (pwsz-text :pointer)   ; LPWSTR out
  (cch-text :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PSFormatForDisplay = Win32::API::More->new('PROPSYS',
    'int PSFormatForDisplay(LPVOID propkey, LPVOID propvar, int pdfFlags, LPWSTR pwszText, DWORD cchText)');
# my $ret = $PSFormatForDisplay->Call($propkey, $propvar, $pdfFlags, $pwszText, $cchText);
# propkey : PROPERTYKEY* -> LPVOID
# propvar : PROPVARIANT* -> LPVOID
# pdfFlags : PROPDESC_FORMAT_FLAGS -> int
# pwszText : LPWSTR out -> LPWSTR
# cchText : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型