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正規化する値を保持するPROPVARIANT。入出力兼用で型変換が行われる。

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

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

typedef PSCoerceToCanonicalValueNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef PSCoerceToCanonicalValueDart = int Function(Pointer<Void>, Pointer<Void>);
final PSCoerceToCanonicalValue = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<PSCoerceToCanonicalValueNative, PSCoerceToCanonicalValueDart>('PSCoerceToCanonicalValue');
// key : PROPERTYKEY* -> Pointer<Void>
// ppropvar : PROPVARIANT* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PSCoerceToCanonicalValue(
  key: Pointer;   // PROPERTYKEY*
  ppropvar: Pointer   // PROPVARIANT* in/out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PSCoerceToCanonicalValue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PSCoerceToCanonicalValue"
  c_PSCoerceToCanonicalValue :: Ptr () -> Ptr () -> IO Int32
-- key : PROPERTYKEY* -> Ptr ()
-- ppropvar : PROPVARIANT* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pscoercetocanonicalvalue =
  foreign "PSCoerceToCanonicalValue"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* key : PROPERTYKEY* -> (ptr void) *)
(* ppropvar : PROPVARIANT* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("PSCoerceToCanonicalValue" pscoerce-to-canonical-value :convention :stdcall) :int32
  (key :pointer)   ; PROPERTYKEY*
  (ppropvar :pointer))   ; PROPVARIANT* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PSCoerceToCanonicalValue = Win32::API::More->new('PROPSYS',
    'int PSCoerceToCanonicalValue(LPVOID key, LPVOID ppropvar)');
# my $ret = $PSCoerceToCanonicalValue->Call($key, $ppropvar);
# key : PROPERTYKEY* -> LPVOID
# ppropvar : PROPVARIANT* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型