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

PropVariantToString

関数
PROPVARIANTを文字列へ変換し指定バッファへ格納する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PropVariantToString(
    const PROPVARIANT* propvar,
    LPWSTR psz,
    DWORD cch
);

パラメーター

名前方向説明
propvarPROPVARIANT*in変換元のPROPVARIANTへのポインタ。文字列への変換対象を指す。
pszLPWSTRout変換結果の文字列を書き込む出力バッファへのポインタ。
cchDWORDinpszバッファのサイズ(文字数単位、終端NUL含む)。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

PropVariantToString = ctypes.windll.propsys.PropVariantToString
PropVariantToString.restype = ctypes.c_int
PropVariantToString.argtypes = [
    ctypes.c_void_p,  # propvar : PROPVARIANT*
    wintypes.LPWSTR,  # psz : LPWSTR out
    wintypes.DWORD,  # cch : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPropVariantToString = propsys.NewProc("PropVariantToString")
)

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

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

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

let propvarianttostring =
  foreign "PropVariantToString"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* propvar : PROPVARIANT* -> (ptr void) *)
(* psz : LPWSTR out -> (ptr uint16_t) *)
(* cch : 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 ("PropVariantToString" prop-variant-to-string :convention :stdcall) :int32
  (propvar :pointer)   ; PROPVARIANT*
  (psz :pointer)   ; LPWSTR out
  (cch :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PropVariantToString = Win32::API::More->new('PROPSYS',
    'int PropVariantToString(LPVOID propvar, LPWSTR psz, DWORD cch)');
# my $ret = $PropVariantToString->Call($propvar, $psz, $cch);
# propvar : PROPVARIANT* -> LPVOID
# psz : LPWSTR out -> LPWSTR
# cch : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型