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

PropVariantToStringWithDefault

関数
PROPVARIANTを文字列へ変換し失敗時は既定値を返す。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

LPWSTR PropVariantToStringWithDefault(
    const PROPVARIANT* propvarIn,
    LPCWSTR pszDefault   // optional
);

パラメーター

名前方向説明
propvarInPROPVARIANT*in評価対象のPROPVARIANTへのポインタ。文字列として解釈を試みる。失敗時は既定文字列が返る。
pszDefaultLPCWSTRinoptional変換に失敗した際に返す既定のUnicode文字列。NULL指定も可能。

戻り値の型: LPWSTR

各言語での呼び出し定義

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

LPWSTR PropVariantToStringWithDefault(
    const PROPVARIANT* propvarIn,
    LPCWSTR pszDefault   // optional
);
[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern IntPtr PropVariantToStringWithDefault(
    IntPtr propvarIn,   // PROPVARIANT*
    [MarshalAs(UnmanagedType.LPWStr)] string pszDefault   // LPCWSTR optional
);
<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PropVariantToStringWithDefault(
    propvarIn As IntPtr,   ' PROPVARIANT*
    <MarshalAs(UnmanagedType.LPWStr)> pszDefault As String   ' LPCWSTR optional
) As IntPtr
End Function
' propvarIn : PROPVARIANT*
' pszDefault : LPCWSTR optional
Declare PtrSafe Function PropVariantToStringWithDefault Lib "propsys" ( _
    ByVal propvarIn As LongPtr, _
    ByVal pszDefault As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PropVariantToStringWithDefault = ctypes.windll.propsys.PropVariantToStringWithDefault
PropVariantToStringWithDefault.restype = wintypes.LPWSTR
PropVariantToStringWithDefault.argtypes = [
    ctypes.c_void_p,  # propvarIn : PROPVARIANT*
    wintypes.LPCWSTR,  # pszDefault : LPCWSTR optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPropVariantToStringWithDefault = propsys.NewProc("PropVariantToStringWithDefault")
)

// propvarIn (PROPVARIANT*), pszDefault (LPCWSTR optional)
r1, _, err := procPropVariantToStringWithDefault.Call(
	uintptr(propvarIn),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszDefault))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPWSTR
function PropVariantToStringWithDefault(
  propvarIn: Pointer;   // PROPVARIANT*
  pszDefault: PWideChar   // LPCWSTR optional
): PWideChar; stdcall;
  external 'PROPSYS.dll' name 'PropVariantToStringWithDefault';
result := DllCall("PROPSYS\PropVariantToStringWithDefault"
    , "Ptr", propvarIn   ; PROPVARIANT*
    , "WStr", pszDefault   ; LPCWSTR optional
    , "Ptr")   ; return: LPWSTR
●PropVariantToStringWithDefault(propvarIn, pszDefault) = DLL("PROPSYS.dll", "char* PropVariantToStringWithDefault(void*, char*)")
# 呼び出し: PropVariantToStringWithDefault(propvarIn, pszDefault)
# propvarIn : PROPVARIANT* -> "void*"
# pszDefault : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef PropVariantToStringWithDefaultNative = Pointer<Utf16> Function(Pointer<Void>, Pointer<Utf16>);
typedef PropVariantToStringWithDefaultDart = Pointer<Utf16> Function(Pointer<Void>, Pointer<Utf16>);
final PropVariantToStringWithDefault = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<PropVariantToStringWithDefaultNative, PropVariantToStringWithDefaultDart>('PropVariantToStringWithDefault');
// propvarIn : PROPVARIANT* -> Pointer<Void>
// pszDefault : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PropVariantToStringWithDefault(
  propvarIn: Pointer;   // PROPVARIANT*
  pszDefault: PWideChar   // LPCWSTR optional
): PWideChar; stdcall;
  external 'PROPSYS.dll' name 'PropVariantToStringWithDefault';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PropVariantToStringWithDefault"
  c_PropVariantToStringWithDefault :: Ptr () -> CWString -> IO CWString
-- propvarIn : PROPVARIANT* -> Ptr ()
-- pszDefault : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let propvarianttostringwithdefault =
  foreign "PropVariantToStringWithDefault"
    ((ptr void) @-> (ptr uint16_t) @-> returning (ptr uint16_t))
(* propvarIn : PROPVARIANT* -> (ptr void) *)
(* pszDefault : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("PropVariantToStringWithDefault" prop-variant-to-string-with-default :convention :stdcall) (:string :encoding :utf-16le)
  (propvar-in :pointer)   ; PROPVARIANT*
  (psz-default (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PropVariantToStringWithDefault = Win32::API::More->new('PROPSYS',
    'LPWSTR PropVariantToStringWithDefault(LPVOID propvarIn, LPCWSTR pszDefault)');
# my $ret = $PropVariantToStringWithDefault->Call($propvarIn, $pszDefault);
# propvarIn : PROPVARIANT* -> LPVOID
# pszDefault : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型