Win32 API 日本語リファレンス
ホームSystem.Variant › VariantToStringArray

VariantToStringArray

関数
VARIANTをワイド文字列配列へ変換する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT VariantToStringArray(
    const VARIANT* var,
    LPWSTR* prgsz,
    DWORD crgsz,
    DWORD* pcElem
);

パラメーター

名前方向説明
varVARIANT*in変換元のVARIANT構造体へのポインタ。文字列配列を想定する。
prgszLPWSTR*out変換結果のワイド文字列ポインタを格納する呼び出し側配列。
crgszDWORDin配列prgszが格納できる要素数。
pcElemDWORD*out実際に書き込まれた要素数を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT VariantToStringArray(
    const VARIANT* var,
    LPWSTR* prgsz,
    DWORD crgsz,
    DWORD* pcElem
);
[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int VariantToStringArray(
    IntPtr var,   // VARIANT*
    IntPtr prgsz,   // LPWSTR* out
    uint crgsz,   // DWORD
    out uint pcElem   // DWORD* out
);
<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function VariantToStringArray(
    var As IntPtr,   ' VARIANT*
    prgsz As IntPtr,   ' LPWSTR* out
    crgsz As UInteger,   ' DWORD
    <Out> ByRef pcElem As UInteger   ' DWORD* out
) As Integer
End Function
' var : VARIANT*
' prgsz : LPWSTR* out
' crgsz : DWORD
' pcElem : DWORD* out
Declare PtrSafe Function VariantToStringArray Lib "propsys" ( _
    ByVal var As LongPtr, _
    ByVal prgsz As LongPtr, _
    ByVal crgsz As Long, _
    ByRef pcElem As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

VariantToStringArray = ctypes.windll.propsys.VariantToStringArray
VariantToStringArray.restype = ctypes.c_int
VariantToStringArray.argtypes = [
    ctypes.c_void_p,  # var : VARIANT*
    ctypes.c_void_p,  # prgsz : LPWSTR* out
    wintypes.DWORD,  # crgsz : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcElem : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procVariantToStringArray = propsys.NewProc("VariantToStringArray")
)

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

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

typedef VariantToStringArrayNative = Int32 Function(Pointer<Void>, Pointer<Pointer<Utf16>>, Uint32, Pointer<Uint32>);
typedef VariantToStringArrayDart = int Function(Pointer<Void>, Pointer<Pointer<Utf16>>, int, Pointer<Uint32>);
final VariantToStringArray = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<VariantToStringArrayNative, VariantToStringArrayDart>('VariantToStringArray');
// var : VARIANT* -> Pointer<Void>
// prgsz : LPWSTR* out -> Pointer<Pointer<Utf16>>
// crgsz : DWORD -> Uint32
// pcElem : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VariantToStringArray(
  var: Pointer;   // VARIANT*
  prgsz: PPWideChar;   // LPWSTR* out
  crgsz: DWORD;   // DWORD
  pcElem: Pointer   // DWORD* out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'VariantToStringArray';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VariantToStringArray"
  c_VariantToStringArray :: Ptr () -> Ptr CWString -> Word32 -> Ptr Word32 -> IO Int32
-- var : VARIANT* -> Ptr ()
-- prgsz : LPWSTR* out -> Ptr CWString
-- crgsz : DWORD -> Word32
-- pcElem : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let varianttostringarray =
  foreign "VariantToStringArray"
    ((ptr void) @-> (ptr (ptr uint16_t)) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* var : VARIANT* -> (ptr void) *)
(* prgsz : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* crgsz : DWORD -> uint32_t *)
(* pcElem : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("VariantToStringArray" variant-to-string-array :convention :stdcall) :int32
  (var :pointer)   ; VARIANT*
  (prgsz :pointer)   ; LPWSTR* out
  (crgsz :uint32)   ; DWORD
  (pc-elem :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VariantToStringArray = Win32::API::More->new('PROPSYS',
    'int VariantToStringArray(LPVOID var, LPVOID prgsz, DWORD crgsz, LPVOID pcElem)');
# my $ret = $VariantToStringArray->Call($var, $prgsz, $crgsz, $pcElem);
# var : VARIANT* -> LPVOID
# prgsz : LPWSTR* out -> LPVOID
# crgsz : DWORD -> DWORD
# pcElem : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型