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

PSCoerceToCanonicalValue

関数
プロパティ値を正規の型と形式に強制変換する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PSCoerceToCanonicalValue(
    const PROPERTYKEY* key,
    PROPVARIANT* ppropvar
);

パラメーター

名前方向
keyPROPERTYKEY*in
ppropvarPROPVARIANT*inout

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

PSCoerceToCanonicalValue = ctypes.windll.propsys.PSCoerceToCanonicalValue
PSCoerceToCanonicalValue.restype = ctypes.c_int
PSCoerceToCanonicalValue.argtypes = [
    ctypes.c_void_p,  # key : PROPERTYKEY*
    ctypes.c_void_p,  # ppropvar : PROPVARIANT* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPSCoerceToCanonicalValue = propsys.NewProc("PSCoerceToCanonicalValue")
)

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