Win32 API 日本語リファレンス
ホームSystem.Com.StructuredStorage › PropVariantChangeType

PropVariantChangeType

関数
PROPVARIANTの値を指定したVARENUM型へ変換して別のPROPVARIANTに格納する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PropVariantChangeType(
    PROPVARIANT* ppropvarDest,
    const PROPVARIANT* propvarSrc,
    PROPVAR_CHANGE_FLAGS flags,
    VARENUM vt
);

パラメーター

名前方向説明
ppropvarDestPROPVARIANT*outこの関数が正常に終了したときに、強制変換された値とその新しい型を受け取る PROPVARIANT 構造体へのポインター。
propvarSrcPROPVARIANT*in元の型で表現された値を格納する、変換元の PROPVARIANT 構造体への参照。
flagsPROPVAR_CHANGE_FLAGSin予約されています。0 を指定する必要があります。
vtVARENUMin値の新しい型を指定します。認識される型名については、以下の表を参照してください。

戻り値の型: HRESULT

公式ドキュメント

PROPVARIANT 構造体に格納された値を、別のバリアント型の同等の値に強制変換します。

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合は標準の COM エラー値を返します。要求された強制変換が実行できない場合は、エラーが返されます。

解説(Remarks)

変換元と変換先の PROPVARIANT 構造体は、別々の構造体である必要があることに注意してください。変換元の PROPVARIANT のデータを新しい変換先のデータで上書きすることはできません。上書きしようとするとエラーになります。

PropVariantChangeType は、次の型の間で以下のように値を変換します。表中の数字は、表の後で説明する条件を示します。

VT_LPWSTR VT_BSTR VT_BOOL VT_FILETIME VT_DATE VT_CLSID
VT_LPWSTR はい はい はい はい (2) はい (2) はい
VT_BSTR はい はい はい はい (2) はい (2) はい
VT_BOOL はい はい はい いいえ いいえ いいえ
VT_I2 はい はい はい いいえ いいえ いいえ
VT_I4 はい はい はい いいえ いいえ いいえ
VT_I8 はい はい はい いいえ いいえ いいえ
VT_UI2 はい はい はい いいえ いいえ いいえ
VT_UI4 はい はい はい いいえ いいえ いいえ
VT_UI8 はい はい はい いいえ いいえ いいえ
VT_R8 はい (3) はい (3) はい いいえ いいえ いいえ
VT_FILETIME はい (2) はい (2) いいえ はい はい いいえ
VT_DATE はい (2) はい (2) いいえ はい はい いいえ
VT_CLSID はい はい いいえ いいえ いいえ はい
 
VT_I2 VT_I4 VT_I8 VT_UI2 VT_UI4 VT_UI8 VT_R8
VT_LPWSTR はい はい はい はい はい はい はい (3)
VT_BSTR はい はい はい はい はい はい はい (3)
VT_BOOL はい はい はい はい はい はい はい
VT_I2 はい はい はい はい (1) はい (1) はい (1) はい (1)
VT_I4 はい (1) はい はい はい (1) はい (1) はい (1) はい (1)
VT_I8 はい (1) はい (1) はい はい (1) はい (1) はい (1) はい (1)
VT_UI2 はい (1) はい はい はい はい はい はい (1)
VT_UI4 はい (1) はい (1) はい はい (1) はい はい はい (1)
VT_UI8 はい (1) はい (1) はい (1) はい (1) はい (1) はい はい (1)
VT_R8 はい (1) はい (1) はい (1) はい (1) はい (1) はい (1) はい
VT_FILETIME いいえ いいえ いいえ いいえ いいえ いいえ いいえ
VT_DATE いいえ いいえ いいえ いいえ いいえ いいえ いいえ
VT_CLSID いいえ いいえ いいえ いいえ いいえ いいえ いいえ
 

条件

  1. 数値型どうしを変換する場合、範囲外となる変換は失敗します。たとえば、負の符号付きの値を符号なしの型に変換する場合や、65535 より大きい 4 バイトの符号なしの値を 2 バイトの符号なしの型に変換する場合です。
  2. 文字列と日付の間で変換する場合は、ローカライズされた表現や「人が読みやすい」表現ではなく、正規の文字列形式が使用されます。形式は "yyyy/mm/dd:hh:mm:ss.fff" (年、月、日、時、分、秒、ミリ秒) です。これは FILETIME 型がサポートする精度よりも低い点に注意してください。ただし、ほとんどの用途では十分です。
  3. 浮動小数点数と文字列の間で変換する場合は、現在のロケールの小数点記号が使用されます。異なるロケール間で移動されるファイルにこれらの値を保存すると、問題が発生する可能性がある点に注意してください。
注意  将来的に、追加の型がサポートされる可能性があります。
 
ベクター (VT_VECTOR) と配列 (VT_ARRAY) の間の変換は、一部のケースでサポートされます。サポートされる場合、要素の数は両者で同じである必要があります。値を 1 つだけ持つベクターはベクターでない値に変換できますが、複数の値を持つベクターはベクターでない型に変換することはできません。

型の間の強制変換は、プロパティ固有の情報を考慮せずに実行されます。プロパティ固有の強制変換には PSCoerceToCanonicalValue を使用してください。また、UI で表示する目的で値の文字列形式が必要な場合は、PropVariantChangeType を使用して値を文字列に強制変換するのではなく、PSFormatForDisplay を使用して、ロケール固有およびプロパティ固有の情報に従って値を書式設定してください。

次のコード例は、より大きなプログラムの一部として使用するもので、PropVariantChangeType を使用して文字列から VT_FILETIME の値を初期化する方法を示しています。

PROPVARIANT propvarString = {0};
                    
HRESULT hr = InitPropVariantFromString(L"2007/01/30:12:00:00.000", &propvarString);
if (SUCCEEDED(hr))
{
    PROPVARIANT propvarFiletime = {0};

    hr = PropVariantChangeType(&propvarFiletime, propvarString, 0, VT_FILETIME);
    if (SUCCEEDED(hr))
    {
        // propvarFiletime には 1/30/2007 12:00 PM の
        // FILETIME 表現が格納される
        PropVariantClear(&propvarFiletime);
    }
    PropVariantClear(&propvarString);
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

PropVariantChangeType = ctypes.windll.propsys.PropVariantChangeType
PropVariantChangeType.restype = ctypes.c_int
PropVariantChangeType.argtypes = [
    ctypes.c_void_p,  # ppropvarDest : PROPVARIANT* out
    ctypes.c_void_p,  # propvarSrc : PROPVARIANT*
    ctypes.c_int,  # flags : PROPVAR_CHANGE_FLAGS
    ctypes.c_ushort,  # vt : VARENUM
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPropVariantChangeType = propsys.NewProc("PropVariantChangeType")
)

// ppropvarDest (PROPVARIANT* out), propvarSrc (PROPVARIANT*), flags (PROPVAR_CHANGE_FLAGS), vt (VARENUM)
r1, _, err := procPropVariantChangeType.Call(
	uintptr(ppropvarDest),
	uintptr(propvarSrc),
	uintptr(flags),
	uintptr(vt),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function PropVariantChangeType(
  ppropvarDest: Pointer;   // PROPVARIANT* out
  propvarSrc: Pointer;   // PROPVARIANT*
  flags: Integer;   // PROPVAR_CHANGE_FLAGS
  vt: Word   // VARENUM
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PropVariantChangeType';
result := DllCall("PROPSYS\PropVariantChangeType"
    , "Ptr", ppropvarDest   ; PROPVARIANT* out
    , "Ptr", propvarSrc   ; PROPVARIANT*
    , "Int", flags   ; PROPVAR_CHANGE_FLAGS
    , "UShort", vt   ; VARENUM
    , "Int")   ; return: HRESULT
●PropVariantChangeType(ppropvarDest, propvarSrc, flags, vt) = DLL("PROPSYS.dll", "int PropVariantChangeType(void*, void*, int, int)")
# 呼び出し: PropVariantChangeType(ppropvarDest, propvarSrc, flags, vt)
# ppropvarDest : PROPVARIANT* out -> "void*"
# propvarSrc : PROPVARIANT* -> "void*"
# flags : PROPVAR_CHANGE_FLAGS -> "int"
# vt : VARENUM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef PropVariantChangeTypeNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32, Uint16);
typedef PropVariantChangeTypeDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final PropVariantChangeType = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<PropVariantChangeTypeNative, PropVariantChangeTypeDart>('PropVariantChangeType');
// ppropvarDest : PROPVARIANT* out -> Pointer<Void>
// propvarSrc : PROPVARIANT* -> Pointer<Void>
// flags : PROPVAR_CHANGE_FLAGS -> Int32
// vt : VARENUM -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PropVariantChangeType(
  ppropvarDest: Pointer;   // PROPVARIANT* out
  propvarSrc: Pointer;   // PROPVARIANT*
  flags: Integer;   // PROPVAR_CHANGE_FLAGS
  vt: Word   // VARENUM
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PropVariantChangeType';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PropVariantChangeType"
  c_PropVariantChangeType :: Ptr () -> Ptr () -> Int32 -> Word16 -> IO Int32
-- ppropvarDest : PROPVARIANT* out -> Ptr ()
-- propvarSrc : PROPVARIANT* -> Ptr ()
-- flags : PROPVAR_CHANGE_FLAGS -> Int32
-- vt : VARENUM -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let propvariantchangetype =
  foreign "PropVariantChangeType"
    ((ptr void) @-> (ptr void) @-> int32_t @-> uint16_t @-> returning int32_t)
(* ppropvarDest : PROPVARIANT* out -> (ptr void) *)
(* propvarSrc : PROPVARIANT* -> (ptr void) *)
(* flags : PROPVAR_CHANGE_FLAGS -> int32_t *)
(* vt : VARENUM -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("PropVariantChangeType" prop-variant-change-type :convention :stdcall) :int32
  (ppropvar-dest :pointer)   ; PROPVARIANT* out
  (propvar-src :pointer)   ; PROPVARIANT*
  (flags :int32)   ; PROPVAR_CHANGE_FLAGS
  (vt :uint16))   ; VARENUM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PropVariantChangeType = Win32::API::More->new('PROPSYS',
    'int PropVariantChangeType(LPVOID ppropvarDest, LPVOID propvarSrc, int flags, WORD vt)');
# my $ret = $PropVariantChangeType->Call($ppropvarDest, $propvarSrc, $flags, $vt);
# ppropvarDest : PROPVARIANT* out -> LPVOID
# propvarSrc : PROPVARIANT* -> LPVOID
# flags : PROPVAR_CHANGE_FLAGS -> int
# vt : VARENUM -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型